POST
/
v1
/
collectives
/
{collectiveId}
/
commands
/
schedule
curl --request POST \
  --url https://platform.realto.io/api/v1/collectives/{collectiveId}/commands/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "triggerTime": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "value": "<string>"
  }
]'
{
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "commands": [
    {
      "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "Canceled",
      "triggerTime": "2023-11-07T05:31:56Z",
      "type": "Disconnect",
      "value": "<string>",
      "error": {
        "title": "<string>",
        "description": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
collectiveId
string
required

The id of the Collective

Query Parameters

​
ignoreCooldown
boolean
default:false

Ignore internal cooldowns of the Entity. Using this may result in Commands not being executed!

Body

The Commands that will be created for an Entity
​
triggerTime
string | null

The trigger time of command.

​
type
string | null

The type of the command.

​
value
string | null

The value of the command.

Response

201 - application/json
Created

A batch of commands.

​
batchId
string | null

The id of the batch.

​
commands
object[] | null

The commands.

A command.

Was this page helpful?