Tasks

post

Create a task

Authorizations

Query parameters

titlestringRequired

Title for this task

body_htmlstringOptional

Body HTML for this task

milestone_idstringOptional

Milestone ID for this task

statusstring · enumOptional

Status for this task

not_started TaskStatusNotStarted

in_progress TaskStatusInProgress

completed TaskStatusCompleted

Possible values:

customer_portal_visiblebooleanOptional

Customer portal visible for this task

Default: false

due_datestringOptional

Due date for this task, in RFC 3339 format

assignee_idstringOptional

Assignee ID for this task

account_idstringOptional

Account ID for this task

project_idstringOptional

Project ID for this task

Responses

200Success

application/json

400Error

application/json

404Error

application/json

post

HTTPcURLJavaScriptPython

POST /tasks HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "contact": {
        "email": "text",
        "id": "text"
      },
      "user": {
        "email": "text",
        "id": "text"
      }
    },
    "body_html": "text",
    "created_at": "text",
    "customer_portal_visible": true,
    "due_date": "text",
    "id": "text",
    "milestone": {
      "id": "text"
    },
    "project": {
      "id": "text"
    },
    "status": "not_started",
    "title": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

patch

Update a task

Authorizations

Path parameters

idstringRequired

The ID of the task to update.

Body

assignee_idstringOptional

Assignee ID for this task

body_htmlstringOptional

Body HTML for this task

customer_portal_visiblebooleanOptional

Customer portal visible for this task

due_datestringOptional

Due date for this task, in RFC 3339 format

milestone_idstringOptional

Milestone ID for this task

project_idstringOptional

Project ID for this task

statusstring · enumOptional

Status for this task

• not_started TaskStatusNotStarted

• in_progress TaskStatusInProgress

• completed TaskStatusCompleted

Possible values:

titlestringOptional

Title for this task

Responses

200Success

application/json

400Error

application/json

404Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /tasks/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "assignee_id": "text",
  "body_html": "text",
  "customer_portal_visible": true,
  "due_date": "text",
  "milestone_id": "text",
  "project_id": "text",
  "status": "not_started",
  "title": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "assignee": {
      "contact": {
        "email": "text",
        "id": "text"
      },
      "user": {
        "email": "text",
        "id": "text"
      }
    },
    "body_html": "text",
    "created_at": "text",
    "customer_portal_visible": true,
    "due_date": "text",
    "id": "text",
    "milestone": {
      "id": "text"
    },
    "project": {
      "id": "text"
    },
    "status": "not_started",
    "title": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

delete

Delete an existing task

Authorizations

Path parameters

idstringRequired

The ID of the task to delete.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /tasks/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}