Create schedule
POST
/v1/schedulesCreate a one-time or recurring automation schedule.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Human-readable name. |
| description | string | No | Human-readable description. |
| agentId | string | Yes | Agent ID. |
| agentName | string | Yes | — |
| task | string | Yes | — |
| contextId | string | No | — |
| contextName | string | No | — |
| environmentId | string | No | Computer ID. |
| environmentName | string | No | — |
| appId | string | No | — |
| scheduleType | one-time | recurring | Yes | — |
| cronExpression | string | No | — |
| scheduledTime | string | No | — |
| timezone | string | No | — |
| enabled | boolean | No | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Schedule createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| schedule | object | No | — |
| schedule.id | string | No | Unique identifier. |
| schedule.userId | string | No | User ID. |
| schedule.organizationId | string | No | — |
| schedule.createdByUserId | string | No | — |
| schedule.name | string | No | Human-readable name. |
| schedule.description | string | No | Human-readable description. |
| schedule.agentId | string | No | Agent ID. |
| schedule.agentName | string | No | — |
| schedule.task | string | No | — |
| schedule.environmentId | string | No | Computer ID. |
| schedule.environmentName | string | No | — |
| schedule.appId | string | No | — |
| schedule.contextId | string | No | — |
| schedule.contextName | string | No | — |
| schedule.scheduleType | one-time | recurring | No | — |
| schedule.cronExpression | string | No | — |
| schedule.scheduledTime | string | No | — |
| schedule.timezone | string | No | — |
| schedule.enabled | boolean | No | — |
| schedule.lastRunAt | string | No | — |
| schedule.nextRunAt | string | No | — |
| schedule.runCount | integer | No | — |
| schedule.successCount | integer | No | — |
| schedule.failureCount | integer | No | — |
| schedule.metadata | object | No | Free-form metadata object. |
| schedule.createdAt | string | No | ISO 8601 timestamp. |
| schedule.updatedAt | string | No | ISO 8601 timestamp. |