Skip to main content
Tasks

Create a task

Creates a new task for the authenticated company.

POST
/tasks

Requires the tasks:create scope.

Authorizations

x-api-keystringheaderrequired

Company API key in the format: rotor_{keyId}_{keySecret}

To obtain an API key:

  1. Log into your Rotor dashboard
  2. Go to Settings → Integrations → API Keys
  3. Create a new key and select the scopes you need
  4. Copy the key — it's only shown once!

Headers

rotor-api-versionenum<string>headerdefault:1.1.0required

Required OpenAPI version header.

Available options: 1.1.0
Example: 1.1.0

Body

application/json
assigned_tostring[]

IDs of active company members to assign (defaults to empty)

Maximum array length: 20
contact_idstring | null

Linked lead or customer ID (must be set together with contact_type)

contact_typeenum<string> | null

Type of the linked contact (must be set together with contact_id)

Available options: lead, customer
due_datestring | null

When the task is due (ISO 8601)

end_datestring | null

Optional end date (ISO 8601); must be on or after due_date

namestringrequired

Task name (required)

Maximum string length: 255
Example: Follow up on roof estimate
notesstring | null

Free-form task notes

Maximum string length: 2000
priorityenum<string>default:medium

Task priority (defaults to "medium")

Available options: low, medium, high
statusenum<string>default:open

Task status (defaults to "open")

Available options: open, in_progress, waiting, done

Response

application/json

Task created successfully

dataobject
messagestring
Example: Task created successfully
statusstring
Example: success

Still need help? Ask the team