Skip to main content
POST
Create contact task
Create a task or call for the contact identified in the path. Set type to task or call. Any supplied Job, pipeline or queue ID must exist in the authenticated workgroup. An unavailable reference is rejected before the task is created. 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}$

Body

application/json

Create a task or call. Text values are trimmed and must be nonempty.

title
string
required
Required string length: 1 - 256
type
enum<string>
required
Available options:
task,
call
priority
enum<string>
Available options:
low,
medium,
high
assigneeId
string
Pattern: ^[a-fA-F0-9]{24}$
reminderEnabled
boolean
reminderMinutesBefore
integer
Required range: 0 <= x <= 10080
date
string
Pattern: ^\d{4}-\d{2}-\d{2}$
time
string
Pattern: ^\d{2}:\d{2}$
description
string
Required string length: 1 - 4000
Maximum array length: 25
Maximum string length: 2048
location
string
Required string length: 1 - 256
phoneNumber
string
Required string length: 1 - 256
Maximum string length: 2048
queueId
string
Pattern: ^[a-fA-F0-9]{24}$
jobspecId
string
Pattern: ^[a-fA-F0-9]{24}$
pipelineId
string
Pattern: ^[a-fA-F0-9]{24}$
stageName
string
Required string length: 1 - 256
subStageName
string
Required string length: 1 - 256

Response

Created contact 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