Update an instance of eventSubscriptions

patch

/services/rest/connect/latest/eventSubscriptions/{id}

Request

Path Parameters
Body ()
An event-based subscription management object
Root Schema : eventSubscriptions
Type: object
An event-based subscription management object
Show Source
Nested Schema : namedIDs-eventSubscriptions-eventType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-integrationUser
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-objectVersion
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-status
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Response

Default Response

Examples

Use the PATCH operation with the following syntax to partially update an event subscription object:

https://your_site_interface/services/rest/connect/version/eventSubscriptions/event_subscription_id

Include the data to be updated in the request body. Only the fields present in the request JSON data are updated. All other fields remain the same.

Request URI example

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

Request body example

{
"objectShapeXml": "<n0:TriggeringObject xmlns:n0=&quot;urn:messages.ws.rightnow.com/v1_4&quot;
 xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;n1:Organization&quot;
 xmlns:n1=&quot;urn:objects.ws.rightnow.com/v1_4&quot;><n1:Notes></n1:Notes></n0:TriggeringObject>"
}

Note:

Quotation marks inside the objectShapeXml field value must be escaped (replaced with &quot; or \") to avoid JSON syntax errors. You must also preserve spaces between XML namespace attributes.

Response example

The status 200 OK is returned. Then getting the data for event subscription 10001 returns the following:

{
  "id": 10001,
  "lookupName": "OrgCreateSubscription",
  "createdTime": "2016-03-21T16:56:05.000Z",
  "updatedTime": "2016-03-22T14:17:48.000Z",
  "class": "Organization",
  "endPoint": "https://myEventReceiverService",
  "eventType": {
    "id": 1,
    "lookupName": "Create"
  },
  "integrationUser": {
    "id": 1,
    "lookupName": "ICS Integration"
  },
  "name": "OrgCreateSubscription",
  "objectShapeXml": "<n0:TriggeringObject xmlns:n0="urn:messages.ws.rightnow.com/v1_4"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="n1:Organization"
    xmlns:n1="urn:objects.ws.rightnow.com/v1_4"><n1:Notes></n1:Notes></n0:TriggeringObject>",
  "objectVersion": {
    "id": 100300,
    "lookupName": "v1.4"
  },
  "status": {
    "id": 1,
    "lookupName": "Active"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/eventSubscriptions/10001"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/eventSubscriptions/10001"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
       eventSubscriptions",
      "mediaType": "application/schema+json"
    }
  ]
}