Pause

POST 
/schedule/:apiKey/:scheduleId/pause

Pause a schedule.

Rate limit

Please be aware of the rate limit for this API endpoint:

• Total limit: Each unique API user is limited to to 60 requests per 60-second window.
• Per scheduleId limit: Each unique scheduleId is limited to 10 request per 60-second window.

If these limits are exceeded, the server will respond with a HTTP 429 status code, indicating too many requests. Please ensure to manage your requests within these limits to maintain uninterrupted service.

Request

Path Parameters

apiKey stringrequired

Possible values: <= 50 characters

API Key of Connector

scheduleId stringrequired

Possible values: <= 32 characters

ID of the schedule

application/json

Body

required

Pause a schedule

object

Responses

200

Schedule response

application/json

Schema

Schema

success

string

required

Possible values: [false, true]

false

errorMessage string

Error message.

While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.

errorCode int32

Error code.

For a complete list of error codes and their meanings, please see the appendix on Error codes.

adapterMessage stringnullable

Adapter specific error message, passed verbatim from the upstream Adapter.

adapterCode stringnullable

Adapter specific error code, passed verbatim from the upstream Adapter.

true

scheduleId string

registrationUuid string

merchantMetaData string

oldStatus ScheduleStatus (string)

Status of the schedule.

Possible values: [ACTIVE, PAUSED, CANCELLED, ERROR, CREATE-PENDING, NON-EXISTING]

newStatus ScheduleStatus (string)

Status of the schedule.

Possible values: [ACTIVE, PAUSED, CANCELLED, ERROR, CREATE-PENDING, NON-EXISTING]

scheduledAt date-time

RFC 3339 Internet Date/Time Format date-time

Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$

Example: 2001-02-03T04:05:06+02:00
property name* any

Example (from schema)

{
  "success": true
}

Success

{
  "success": true,
  "scheduleId": "SC-1234-1234-1234-1234-1234-1234",
  "oldStatus": "ACTIVE",
  "newStatus": "PAUSED"
}

Error

{
  "success": false,
  "scheduleId": "SC-1234-1234-1234-1234-1234-1234",
  "oldStatus": "PAUSED",
  "newStatus": "PAUSED",
  "errorMessage": "The status of the schedule is not valid for the requested operation",
  "errorCode": 7070
}

429

Rate limit exceeded

application/json

Schema

Schema

success boolean

Returns true or false depending on whether the request was successful.

Possible values: [false]

errorMessage string

Error message.

While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.

errorCode int32
details stringnullable
property name* any

Example (from schema)

{
  "success": false,
  "errorMessage": "string",
  "errorCode": 0,
  "details": "string"
}

Example

{
  "success": false,
  "errorCode": 1009,
  "errorMessage": "Too many requests"
}

Loading...