APICRMActivitiesCreate Activity

Create Activity

Create a CRM activity. subject and description are required. Defaults: priority Low, type Incident, source Portal, status Open. The requester is the user who owns the API key. dueBy accepts any date string; a year other than the current one is replaced with the current year and an unparseable value is ignored. tags is an array of strings. When assignedToId is set the assignee receives an assignment email. Responds 201 with the activity and its related records.

Created: September 16, 2026

Updated: September 16, 2026

Overview

POST

https://dashboard.vinsi.ai/api/crm/activities

Request

Headers

Content-Type

string

application/json

x-api-key

string

REQUIRED

Request Body

{11 items"subject":string"Follow up on pricing question"
"description":string"Customer asked for pricing on ..."
"priority":string"Medium"
"type":string"Task"
"source":string"Portal"
"dueBy":string"2026-09-18T17:00:00.000Z"
"assignedToId":string"cmexampleuser0000000000002"
"tags":[1 item0:string"pricing"
]
"contactId":int1042
"companyId":int318
"dealId":int77
}

Response

{32 items"id":int5120
"activityNumber":string"ACT-00128-K3F9"
"subject":string"Follow up on pricing question"
"description":string"Customer asked for pricing on ..."
"status":string"Open"
"priority":string"Medium"
"type":string"Task"
"source":string"Portal"
"dueBy":string"2026-09-18T17:00:00.000Z"
"organizationId":string"cmexampleorg00000000000001"
"requesterId":string"cmexampleuser0000000000001"
"assignedToId":string"cmexampleuser0000000000002"
"departmentId":null
"groupId":null
"tags":string"["pricing"]"
"customFields":string"{}"
"contactId":int1042
"companyId":int318
"dealId":int77
"engagementId":null
"closedAt":null
"resolvedAt":null
"firstResponseAt":null
"lastDueReminderAt":null
"createdAt":string"2026-09-15T20:11:05.000Z"
"updatedAt":string"2026-09-15T20:11:05.000Z"
"Requester":{4 items"id":string"cmexampleuser0000000000001"
"firstName":string"Jane"
"lastName":string"Doe"
"email":string"jane.doe@example.com"
}
"AssignedTo":{4 items"id":string"cmexampleuser0000000000002"
"firstName":string"Sam"
"lastName":string"Rivera"
"email":string"sam.rivera@example.com"
}
"Department":null
"Group":null
"Contact":{5 items"id":int1042
"firstName":string"Alex"
"lastName":string"Morgan"
"email":string"alex.morgan@example.com"
"phone":string"+15555550142"
}
"Company":{2 items"id":int318
"name":string"Acme Dental"
}
}

Endpoint Explorer

Note: You must be already authenticated on https://dashboard.vinsi.ai/ to use this API tester.

POST

Headers

Content-Type: *

x-api-key: *

Response

No response yet. Click Send to test the API.