Skip to main content
POST
Subscribe a customer or business to monitoring

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The monitoring subscription.

business_id
string<uuid>

Business ID for the application. An application must have either a Business or a customer associated with it.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

person_id
string<uuid>

Unique ID for the person. Exactly one of person_id or business_id must be set.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

The new monitoring subscription.

business_id
string<uuid>

Business ID for the application. An application must have either a Business or a customer associated with it.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

creation_time
string<date-time>
read-only

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

id
string<uuid>
read-only

Unique identifier for this subscription.

last_updated_time
string<date-time>
read-only

The date and time the resource was last update.

Example:

"2010-05-06T12:23:34.321Z"

metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

person_id
string<uuid>

Unique ID for the person. Exactly one of person_id or business_id must be set.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"