Update subscriptions

Updates a subscriptions object for Dynamics 365 Business Central. A subscription is valid for 3 days unless it is updated. PATCH requests will perform a handshake with the subscriber.

HTTP request

Replace the URL prefix for Dynamics 365 Business Central depending on environment following the guideline.

PATCH businesscentralPrefix/subscriptions({id})

Request headers

Header Value
Authorization Bearer {token}. Required.
If-Match *

Request body

Here is an example of the request.

PATCH https://{businesscentralPrefix}/api/v1.0/subscriptions({id})
Content-type: application/json

{
  "notificationUrl": "https://{notificationUrl}",
  "resource": "/api/v1.0/companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers",
  "clientState": "optionalValueOf2048"
}

Response

If successful, this method returns a 200 OK response code and a subscription object in the response body.

Example

Request

Here is an example of the request.

https://{businesscentralPrefix}/api/v1.0/subscriptions({id}) 

Response Here is an example of the response.

Note

The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

{
  "subscriptionId": "c670ea73cacb459bb51dc1740da2f1db",
  "notificationUrl": "https://contoso.com/myCallbacks",
  "resource": "companies(f64eba74-dacd-4854-a584-1834f68cfc3a)/customers",
  "userId": "00000000-0000-0000-0000-000000000001",
  "lastModifiedDateTime": "2018-10-12T12:32:35Z",
  "clientState": "anytextvalueof2048",
  "expirationDateTime": "2018-10-15T12:32:35Z"
}

Important

Handshake is mandatory when creating a subscription and renewing a subscription. See Working with Webhooks.

See also

Tips for working with the APIs

Error Codes
Subscription Resource Type
Get subscriptions
Create subscriptions
Delete subscriptions
Microsoft REST API Guidelines