Post create a subscription
/api/v1/notifications/subscriptions
{basePath}/notifications/subscriptions
The API creates a subscription to a resource for the current subscriber.Request
- application/json
object-
callbackUri(required):
string
Callback Uri for the subscription's notifications.
-
locRef:
string
The location identifier for this subscription.
-
messageType(required):
object MessageType
Information about the type of message.
-
orgShortName(required):
string
The organization identifier for this subscription.
-
postOfficeOptions(required):
object PostOfficeOptions
Information about the PostOffice for the subscription
-
rvcRef:
string
The revenue center identifier for this subscription.
object-
id(required):
string
Identifier of the message type [Source - POS].
Message type ID Supported hierarchy level subscriptions CheckNotification Supports organization, property, and revenue center hierarchy level subscriptions. OrganizationsNotification Supports organization, property, and revenue center hierarchy level subscriptions. ConfigurationNotification Supports organization, property, and revenue center hierarchy level subscriptions. EmployeesNotification Supports organization and property hierarchy level subscriptions.
object-
PostOfficeType:
string
Information about the PostOffice for the subscription Valid values are "PushOnePostOffice"
Response
- application/json
200 Response
object-
callbackUri(required):
string
Callback Uri for the subscription's notifications.
-
locRef:
string
The location identifier for this subscription.
-
messageType(required):
object MessageType
Information about the type of message.
-
orgShortName(required):
string
The organization identifier for this subscription.
-
postOfficeOptions(required):
object PostOfficeOptions
Information about the PostOffice for the subscription
-
rvcRef:
string
The revenue center identifier for this subscription.
-
subscriptionId(required):
string
Identifier(GUID) of this subscription.
object-
id(required):
string
Identifier of the message type [Source - POS].
Message type ID Supported hierarchy level subscriptions CheckNotification Supports organization, property, and revenue center hierarchy level subscriptions. OrganizationsNotification Supports organization, property, and revenue center hierarchy level subscriptions. ConfigurationNotification Supports organization, property, and revenue center hierarchy level subscriptions. EmployeesNotification Supports organization and property hierarchy level subscriptions.
object-
PostOfficeType:
string
Information about the PostOffice for the subscription Valid values are "PushOnePostOffice"
400 Response
401 Response
-
WWW-Authenticate: string
Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.
The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.
No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: BearerExpired token: The access token has expired. The timestamp in this example is illustrative.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"Invalid signature: The token signature is invalid. For example, the token may have been modified.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.
The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.
403 Response
404 Response
Examples
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"callbackUri": "string",
"messageType": {
"id": "CheckNotification"
},
"postOfficeOptions": {
"PostOfficeType": "string"
},
"orgShortName": "string",
"locRef": "string",
"rvcRef": "string"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"subscriptionId": "string",
"callbackUri": "string",
"messageType": {
"id": "CheckNotification"
},
"postOfficeOptions": {
"PostOfficeType": "string"
},
"orgShortName": "string",
"locRef": "string",
"rvcRef": "string"
}