/actions Create an action
Creates an action on a contact. contact_id and text are required — text is the step to take, max 140 characters. status sets the action type: asap, date, date_time, waiting or queued (default date); assignee_id defaults to the calling user. A contact holds one ASAP action per assignee — creating a second demotes the existing one to a dated action for today.
Request body
contact_idstringbson-idID of the contact, with whom the action is associated
assignee_idstringbson-idID of the user, to whom the action is assigned. Defaults to the logged API user's ID.
statusstringStatus of the action
enum: asap · date · date_time · waiting · queued · queued_with_date · done
textstringThe main text/description of the action
datestringdateDue date for the action (status must be one of `date`, `date_time` or `queued_with_date`). Defaults to today's date.
exact_timeintegerunix-timestampThe UNIX Epoch time in seconds the action is due (status must be `date_time`)
positionintegerint32The position of the action (in the list of queued actions)
Responses
201 Created
statusintegerint32Response code
messagestringResponse message
timestampintegerunix-timestampResponse time
dataobjectobject fields →
actionobjectCompletable tasks related to Contacts. ASAP first, then dated actions ordered by due date (overdue first), followed by waiting for (blocked) and finally queued actions (without any date).
object fields →
idstringbson-idID of the action
assignee_idstringbson-idrequiredID of the user, to whom the action is assigned. Defaults to the logged API user's ID.
contact_idstringbson-idrequiredID of the contact, with whom the action is associated
textstringrequiredThe main text/description of the action
statusstringStatus of the action
enum: asap · date · date_time · waiting · queued · queued_with_date · done
datestringdateDue date for the action (status must be one of `date`, `date_time` or `queued_with_date`). Defaults to today's date.
exact_timeintegerunix-timestampThe UNIX Epoch time in seconds the action is due (status must be `date_time`)
positionintegerint32The position of the action (in the list of queued actions)
donebooleanHas the action been marked as complete?
done_atstringdateThe date the action was completed (only returned, if action complete)
created_atstringdate-timeCreation time of the action
modified_atstringdate-timeLast modification time of the action
Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.