Create a task

Create a new task in your workspace.

POST /tasks

Create a task

cURL

curl --request POST \
  --url https://{your-subdomain}.neetocrm.com/api/external/v1/tasks \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "task": {
    "title": "Follow up with Eve",
    "description": "Send proposal",
    "status": "pending",
    "priority": "high",
    "due_date": "2024-01-15",
    "due_time": "14:00",
    "owner_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "contact_id": 1,
    "company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "deal_id": 1,
    "lead_id": 1
  }
}
'

201

{
  "task": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": "Follow up with Eve",
    "description": "Send proposal",
    "status": "pending",
    "priority": "high",
    "due_date": "2025-03-20",
    "due_time": "14:00",
    "owner_id": null,
    "contact_id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
    "company_id": null,
    "deal_id": null,
    "lead_id": null,
    "organization_id": "org-123",
    "owner": null,
    "created_at": "2025-03-15T10:30:00.000Z",
    "updated_at": "2025-03-15T10:30:00.000Z"
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key · string · required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Body

application/json

task · object

Hide child attributes

task. title · string · required

Task title.

Example:

"Follow up with Eve"

task. description · string

Task description.

Example:

"Send proposal"

task. status · string

Task status.

Example:

"pending"

task. priority · string

Task priority.

Example:

"high"

task. due_date · string<date>

Due date.

Example:

"2024-01-15"

task. due_time · string

Due time.

Example:

"14:00"

task. owner_id · string

Unique identifier of the owner.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

task. contact_id · integer

Associated contact ID.

Example:

1

task. company_id · string

Unique identifier of the associated company.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

task. deal_id · integer

Associated deal ID.

Example:

1

task. lead_id · integer

Associated lead ID.

Example:

1

Response

201 - application/json

Task created successfully.

task · object

Hide child attributes

task. id · string

Unique identifier for the task.

task. title · string

Title of the task.

task. description · string | null

Description of the task.

task. status · string

Current status of the task.

task. priority · string

Priority level of the task.

task. due_date · string<date> | null

Due date of the task.

task. due_time · string | null

Due time of the task.

task. owner_id · string | null

Unique identifier of the owner.

task. contact_id · string | null

Unique identifier of the associated contact.

task. company_id · string | null

Unique identifier of the associated company.

task. deal_id · string | null

Unique identifier of the associated deal.

task. lead_id · string | null

Unique identifier of the associated lead.

task. organization_id · string

Unique identifier of the organization.

task. owner · object

Owner of the task.

Hide child attributes

task.owner. id · string

Unique identifier of the owner.

task.owner. name · string

Name of the owner.

task. created_at · string<date-time>

Timestamp when the task was created.

task. updated_at · string<date-time>

Timestamp when the task was last updated.