Sign in

v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Post Task

Create a new task.

Tasks are work items that can be linked to any CRM entity.

Request Body (TaskRequest):

  • name (required): Task title.
  • description (optional): Task details.
  • status (default: "assigned"): Values: assigned, in-progress, rejected, reviewsubmit, reviewpass, completed.
  • priority (optional): 1=highest, 4=lowest.
  • due_date (optional): Epoch timestamp (seconds).
  • subject_type (optional): Entity type to link. Values: lead, property, contact, opportunity, account, insurance_policy, entity_list, none.
  • subject (optional): Linked entity ObjectId.
  • userid (optional): Assigned user ID.
  • action (default: "general"): Task type. Values: general, call, email, text, postcard, support-request, ambivo-support, work-order, attend-meeting, renewal-reminder.
  • action_data (optional): Action-specific details (e.g., phone number for a call task).
  • tags (optional): Up to 10 tags.

Response: The created task object.

post/crm/tasks

Request body

namestring required

Task title

descriptionstring nullable

Task details

statusstring nullable

Possible values: assigned, in-progress, rejected, reviewsubmit, reviewpass, completed

priorityinteger nullable

Priority 1=highest, 4=lowest

due_dateinteger nullable

Due date (epoch timestamp seconds)

subject_typestring nullable

Possible values: lead, property, contact, opportunity, account, insurance_policy, entity_list, none

subjectstring nullable

Linked entity ObjectId

useridstring nullable

Assigned user ID

actionstring nullable

Task type: general, call, email, text, postcard, support-request, ambivo-support, work-order, attend-meeting, renewal-reminder

action_dataobject nullable

Action-specific details (e.g. phone number for call)

tagsstring[] nullable

List of tags

Response

Successful Response

idstring required
namestring required
descriptionstring nullable
statusstring nullable
priorityinteger nullable
due_datestring nullable
is_completedboolean nullable
completed_datestring nullable
subject_typestring nullable
subjectstring nullable
useridstring nullable
created_by_useridstring nullable
actionstring nullable
action_dataobject nullable
tagsstring[] nullable
created_datestring nullable
updated_datestring nullable