Skip to main content
POST
/
v2.0
/
playbooks
/
{playbookId}
/
schedule
Schedule a Playbook Run via task-manager
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId}/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "entrypoint": "61f25579055c2f43c249a181",
  "flowId": "010d1970-89b9-4012-892b-53c78ef6c117",
  "localeId": "8b3b45e2-48f9-446d-a4c5-35d8284a01b2"
}'
This response does not have an example.

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
playbookId
string
required

The Id of the Playbook

Required string length: 24

Body

application/json
​
entrypoint
string

snapshot or project ID

Example:

"61f25579055c2f43c249a181"

​
flowId
string

The reference ID of the flow

Example:

"010d1970-89b9-4012-892b-53c78ef6c117"

​
localeId
string

The reference ID of locale

Example:

"8b3b45e2-48f9-446d-a4c5-35d8284a01b2"

Response

Successfully scheduled the Playbook Run.

⌘I