Create a Task

POST 
/v2/tasks

Creates a task.

Request

multipart/form-data

Body

required

subject string

Subject line of the task.

person_id string

ID of the person to be contacted

user_id integer

ID of the user linked to the task. Defaults to the authenticated user.

user_guid string

Guid of the user linked to the task. Defaults to the authenticated user.

task_type string

Task type, valid options are: call, email, general

due_date string

Date of when the Task is due, ISO-8601 date format required

remind_at string

Datetime of when the user will be reminded of the task, ISO-8601 datetime format required

idempotency_key string

Establishes a unique identifier to prevent duplicates from being created

description string

A description of the task recorded for person at completion time

Responses

200

Success

application/json

Schema

Schema

id integer

ID of Task

created_at date-time

Datetime of when the Task was created

updated_at date-time

Datetime of when the Task was last updated

description string

A description of the task recorded for person at completion time

due_date date

Date of when the Task is due, ISO-8601 date format required

due_at date-time

Datetime of when the Task is due, can be null. ISO-8601 datetime format required

subject string

Subject line of the task

current_state string

The state of the task. Valid states are: scheduled, completed

person object
The person to be contacted
id integer
_href string
opportunity object
The opportunity associated with task
id integer
_href string
user object
User who is assigned the task
id integer
_href string
created_by_user object
User who created the task
id integer
_href string
task_type string

The type of the task. Valid types are: call, email, general

remind_at date-time

Datetime of when the user will be reminded of the task, ISO-8601 datetime format required

expires_after date-time

Datetime of when the the task will expire, ISO-8601 datetime format required

completed_at date-time

Datetime of when the task was completed, ISO-8601 datetime format required

completed_by object
User who completed the task
id integer
_href string

Example (from schema)

{
  "id": 1,
  "created_at": "2024-01-01T00:00:00.000000+00:00",
  "updated_at": "2024-01-01T00:00:00.000000+00:00",
  "description": "Ask John Wick about his dog.",
  "due_date": "2025-01-01",
  "due_at": "2024-01-01T00:00:00.000000+00:00",
  "subject": "Call John Wick",
  "current_state": "scheduled",
  "person": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/people/1"
  },
  "opportunity": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/opportunities/1"
  },
  "user": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/users/1"
  },
  "created_by_user": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/users/1"
  },
  "task_type": "call",
  "remind_at": "2024-01-01T00:00:00.000000+00:00",
  "expires_after": "2024-01-01T00:00:00.000000+00:00",
  "completed_at": "2024-01-01T00:00:00.000000+00:00",
  "completed_by": {
    "id": 1,
    "_href": "https://api.salesloft.com/v2/users/1"
  }
}

Loading...