Tasks & Projects

post

Create a task

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

account_idstringOptional

Account ID for this task

assignee_idstringOptional

Assignee ID for this task

body_htmlstringOptional

Body HTML for this task

customer_portal_visiblebooleanOptional

Customer portal visible for this task

Default: false

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:

titlestringRequired

Title for this task

Responses

200Success

application/json

400Error

application/json

404Error

application/json

post

/tasks

HTTPcURLJavaScriptPython

POST /tasks HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "account_id": "text",
  "assignee_id": "text",
  "body_html": "text",
  "customer_portal_visible": false,
  "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"
}

patch

Update a task

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the task to update.

Body

application/json

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

/tasks/{id}

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

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the task to delete.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

delete

/tasks/{id}

HTTPcURLJavaScriptPython

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

{
  "request_id": "text"
}

patch

Update a project

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the project to update.

Body

application/json

customer_portal_visiblebooleanOptional

Customer portal visible for this project

description_htmlstringOptional

Description HTML for this project

end_datestringOptional

End date for this project, in RFC 3339 format

is_archivedbooleanOptional

Whether the project is archived

namestringOptional

Name for this project

owner_idstringOptional

Owner ID for this project

start_datestringOptional

Start date for this project, in RFC 3339 format

Responses

200Success

application/json

400Error

application/json

404Error

application/json

patch

/projects/{id}

HTTPcURLJavaScriptPython

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

{
  "customer_portal_visible": true,
  "description_html": "text",
  "end_date": "text",
  "is_archived": true,
  "name": "text",
  "owner_id": "text",
  "start_date": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "archived_at": "text",
    "created_at": "text",
    "customer_portal_visible": true,
    "description_html": "text",
    "end_date": "text",
    "id": "text",
    "is_archived": true,
    "name": "text",
    "owner_id": "text",
    "project_template": {
      "id": "text"
    },
    "start_date": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

delete

Delete an existing project

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the project to delete.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

delete

/projects/{id}

HTTPcURLJavaScriptPython

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

{
  "request_id": "text"
}

post

Create a project

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

account_idstringRequired

Account ID for this project

customer_portal_visiblebooleanOptional

Customer portal visible for this project

Default: false

description_htmlstringOptional

Description HTML for this project

end_datestringOptional

End date for this project, in RFC 3339 format

namestringRequired

Name for this project

owner_idstringOptional

Owner ID for this project

project_template_idstringOptional

Project template ID for this project

start_datestringOptional

Start date for this project, in RFC 3339 format

Responses

200Success

application/json

400Error

application/json

404Error

application/json

post

/projects

HTTPcURLJavaScriptPython

POST /projects HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "account_id": "text",
  "customer_portal_visible": false,
  "description_html": "text",
  "end_date": "text",
  "name": "text",
  "owner_id": "text",
  "project_template_id": "text",
  "start_date": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "archived_at": "text",
    "created_at": "text",
    "customer_portal_visible": true,
    "description_html": "text",
    "end_date": "text",
    "id": "text",
    "is_archived": true,
    "name": "text",
    "owner_id": "text",
    "project_template": {
      "id": "text"
    },
    "start_date": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}

patch

Update a milestone

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the milestone to update.

Body

application/json

due_datestringOptional

Due date for this milestone, in RFC 3339 format

namestringOptional

Name for this milestone

Responses

200Success

application/json

400Error

application/json

404Error

application/json

patch

/milestones/{id}

HTTPcURLJavaScriptPython

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

{
  "due_date": "text",
  "name": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "created_at": "text",
    "due_date": "text",
    "id": "text",
    "name": "text",
    "project": {
      "id": "text"
    },
    "updated_at": "text"
  },
  "request_id": "text"
}

post

Create a milestone

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

account_idstringOptional

Account ID for this project

due_datestringOptional

Due date for this milestone, in RFC 3339 format

namestringRequired

Name for this milestone

project_idstringRequired

Project ID for this milestone

Responses

200Success

application/json

400Error

application/json

404Error

application/json

post

/milestones

HTTPcURLJavaScriptPython

POST /milestones HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "account_id": "text",
  "due_date": "text",
  "name": "text",
  "project_id": "text"
}

{
  "data": {
    "account": {
      "id": "text"
    },
    "created_at": "text",
    "due_date": "text",
    "id": "text",
    "name": "text",
    "project": {
      "id": "text"
    },
    "updated_at": "text"
  },
  "request_id": "text"
}

delete

Delete a milestone

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the milestone to delete.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

delete

/milestones/{id}

HTTPcURLJavaScriptPython

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

{
  "request_id": "text"
}