Edit

(cloudMigration API) Create subscriptions

Creates a subscriptions in Business Central.

HTTP request

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

POST businesscentralPrefix/companies({id})/subscriptions({id})

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json
If-Match Required. When this request header is included and the eTag provided does not match the current tag on the subscriptions, the subscriptions will not be updated.

Request body

In the request body, supply a JSON representation of a subscriptions object.

Response

If successful, this method returns 201 Created response code and a subscriptions object in the response body.

Example

Request

Here is an example of the request.

POST https://{businesscentralPrefix}/api/v1.0/companies({id})/subscriptions({id})
Content-type: application/json
{
    "subscriptionId" : "",
    "notificationUrl" : "",
    "resource" : "",
    "userId" : "",
    "lastModifiedDateTime" : "",
    "clientState" : "",
    "expirationDateTime" : "",
    "systemCreatedAt" : "",
    "systemCreatedBy" : "",
    "systemModifiedAt" : "",
    "systemModifiedBy" : ""
}

Response

Here is an example of the response.

HTTP/1.1 201 Created
Content-type: application/json
{
    "subscriptionId" : "",
    "notificationUrl" : "",
    "resource" : "",
    "userId" : "",
    "lastModifiedDateTime" : "",
    "clientState" : "",
    "expirationDateTime" : "",
    "systemCreatedAt" : "",
    "systemCreatedBy" : "",
    "systemModifiedAt" : "",
    "systemModifiedBy" : ""
}

Tips for working with the APIs
subscriptions
GET subscriptions
DELETE subscriptions
PATCH subscriptions

  • Last updated on