sdkDeterministic

Create crm task

pipeline.createCrmTask

Create a task without sending. Reuse idempotencyKey for uncertain retries within 24 hours.

Parameters

workspaceId
string
No description.
prospectIdrequired
string
No description.
titlerequired
string
No description.
dueDate
string | null
No description.
idempotencyKeyrequired
string
No description.

Example

TypeScripttypescript
await pipeline.createCrmTask({
"prospectId": "00000000-0000-4000-8000-000000000000",
"title": "example",
"idempotencyKey": "example"
})

Response

Success response schemajson schema
{
"type": "object",
"properties": {
"task": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"prospectId": {
"type": "string"
},
"title": {
"type": "string"
},
"dueDate": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"done"
]
},
"createdBy": {
"type": "string"
},
"createdAt": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": [
"string",
"null"
]
},
"prospectName": {
"type": [
"string",
"null"
]
},
"companyName": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"workspaceId",
"prospectId",
"title",
"dueDate",
"status",
"createdBy",
"createdAt",
"updatedAt"
]
},
"activityId": {
"type": "string"
}
},
"required": [
"task",
"activityId"
]
}

Exceptions

PipelineError
Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.
Pipeline TypeScript SDK documentation | Pipeline