Suppressing Rules and External Events

You can use custom HTTP headers with POST, PATCH, and DELETE requests to suppress rules, external events, or both.

Use one of the following HTTP headers with a value of true or yes:
  • OSvC-CREST-Suppress-Rules
  • OSvC-CREST-Suppress-ExternalEvents
  • OSvC-CREST-Suppress-All

Note:

You can't suppress rules with DELETE requests.

Request URI Example

This example creates an account and suppresses both rules and external events. It uses the following syntax:

https://mysite.example.com/services/rest/connect/v1.4/accounts

The following table lists the header used for suppressing rules and external events:

Header Value

OSvC-CREST-Suppress-All

true

Request body example

{
  "login": "number1",
  "name": {
    "first": "Fearless",
    "last": "Leader"
  },
  "newPassword": "NumeroUno001",
  "profile": {
    "id": 2
  },
 "staffGroup": {
    "id": 100030
  }
}

Response body example

{
  "id": 4,
  "lookupName": "Fearless Leader",
  "accountHierarchy": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/4/accountHierarchy"
      },
      {
        "rel": "full",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/4/accountHierarchy/
         {accountHierarchy_id}",
        "templated": true
      }
    ]
  },
  "attributes": {
    "accountLocked": false,
    "canModifyEmailSignature": false,
    "forcePasswordChange": false,
    "infrequentUser": false,
    "passwordNeverExpires": false,
    "permanentlyDisabled": false,
    "staffAssignmentDisabled": false,
    "viewsReportsDisabled": false,
    "virtualAccount": false
  },
  "country": null,
  "customFields": {
    "c": {}
  },
  "displayName": null,
  "displayOrder": 2,
  "emailNotification": null,
  "emails": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/4/emails"
      },
      {
        "rel": "full",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/4/emails/{email_id}",
        "templated": true
      }
    ]
  },
  "login": "number1",
  "manager": null,
  "name": {
    "first": "Fearless",
    "last": "Leader"
  },
  "nameFurigana": {
    "first": null,
    "last": null
  },
  "notificationPending": false,
  "passwordExpirationTime": "2016-08-07T04:00:00.000Z",
  "phones": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/4/phones"
      },
      {
        "rel": "full",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/4/phones/{phone_id}",
        "templated": true
      }
    ]
  },
  "profile": {
    "id": 2,
    "lookupName": "Overlord"
  },
  "salesSettings": {
    "defaultCurrency": {
      "id": 1,
      "lookupName": "USD"
    },
    "territory": null
  },
  "serviceSettings": {},
  "signature": null,
  "staffGroup": {
    "id": 100030,
    "lookupName": "Overlords"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/4"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/4"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
      "mediaType": "application/schema+json"
    }
  ]
}