Skip to main content
PATCH
Update or complete a contact task
Update only the supplied fields on the task identified by the path; omitted fields and the task ID remain unchanged. For example, send {"title":"Review assessment","date":"2026-11-12"} to change the title and due date, or {"done":true} after the work is complete. Set optional Job, pipeline, stage, sub-stage, queue, or assignee fields to null to clear them. Clear related fields together when leaving some in place would make the relationship invalid. An enabled reminder requires an assignee. Disable the reminder in the task editor before clearing the assignee; this endpoint does not change reminder settings. The task must belong to the contact and authenticated workgroup. Supplied Job, pipeline, stage and sub-stage values must form a valid relationship. Synced provider tasks are read-only. Completing a task may continue a waiting sequence and remove the task from open queue counts; retrying a completion keeps the same task. Rate limit: 30 requests/minute per endpoint and workgroup. Details.

Authorizations

x-api-key
string
header
required

Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration.

Path Parameters

contactId
string
required
Pattern: ^[a-fA-F0-9]{24}$
taskId
string
required
Pattern: ^[a-fA-F0-9]{24}$

Body

application/json

Partial update. Omitted fields are preserved. Completing a task may continue a sequence.

title
string
Required string length: 1 - 256
description
string
Maximum string length: 4000
date
string<date>
time
string
Pattern: ^([01]\d|2[0-3]):[0-5]\d$
done
boolean
priority
enum<string>
Available options:
low,
medium,
high
assigneeId
string | null
Pattern: ^[a-fA-F0-9]{24}$
queueId
string | null
Pattern: ^[a-fA-F0-9]{24}$
jobspecId
string | null
Pattern: ^[a-fA-F0-9]{24}$
pipelineId
string | null
Pattern: ^[a-fA-F0-9]{24}$
stageName
string | null
Required string length: 1 - 256
subStageName
string | null
Required string length: 1 - 256

Response

Updated task.

A native Jobin task associated with a contact.

id
string
required

Task identifier.

title
string
required
type
enum<string>
required
Available options:
task,
call,
meeting
done
boolean
required
contactId
string | null

Associated contact identifier.

date
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
time
string | null
Pattern: ^\d{2}:\d{2}$
description
string | null
location
string | null
phoneNumber
string | null
flagged
boolean
outcome
string | null
priority
enum<string> | null
Available options:
low,
medium,
high,
null
assigneeId
string | null
candidateIds
string[]
queueId
string | null
jobspecId
string | null
pipelineId
string | null
stageName
string | null
subStageName
string | null
reminderEnabled
boolean
reminderMinutesBefore
integer | null
source
string
readOnly
boolean
createdAt
string<date-time> | null
updatedAt
string<date-time> | null