Creates a scheduled task

post

https://api.solidarity.tech/v1/scheduled_tasks

Creates a scheduled task with the specified details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Data containing scheduled task information

due_at

date-time

required

The date and time when the task is due. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer. Must be in the future, or the request returns a 422.

remind_at

date-time | null

The date and time when a reminder for the task should be sent. Accepts either an ISO 8601 formatted date-time string or a UNIX timestamp as a string or integer. Must be before due_at, or the request returns a 422.

agent_user_id

int64

required

Identifier for the agent user assigned to the task. Must be a person this API key can see, or the request returns a 404.

user_id

int64

required

Identifier for the person the task is about. Must be a person this API key can see, or the request returns a 404.

created_by_user_id

int64 | null

Optional identifier for the person who created the task. The dashboard shows it as the creator of the task. Must be a person this API key can see, or the request returns a 404.

notes

string | null

Additional notes or details about the task

marked_as_completed

boolean | null

Indicates if the task has been marked as completed

Responses

404

agent or user agent not in organization

201scheduled task created

401The API key is missing or invalid, the billing plan has no API access, or the account is inactive.

422due_at or remind_at is not a valid date, due_at is missing or not in the future, or remind_at is not before due_at