{ "message": "Invalid input (details will vary based on the error)", "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf", "category": "VALIDATION_ERROR", "links": { "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base" }}
Subscriptions
Pause subscription
Pause an active subscription using the subscription ID.
{ "message": "Invalid input (details will vary based on the error)", "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf", "category": "VALIDATION_ERROR", "links": { "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base" }}
Required Scopes
Authorizations
oauth2oauth2
Authorization
string
header
required
The access token received from the authorization server in the OAuth 2.0 flow.
Scopes
crm.schemas.subscriptions.write
crm.objects.subscriptions.write
Path Parameters
objectId
integer<int64>
required
The ID of the subscription.
Body
application/json
pauseReason
string
A string indicating the reason for pausing the subscription.
Response
default - */*
Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered.
category
string
required
The error category
correlationId
string<uuid>
required
A unique identifier for the request. Include this value with any error reports or support tickets
Example:
"aeb5f871-7f07-4993-9211-075dc63e7cbf"
message
string
required
A human readable message describing the error along with remediation steps where appropriate