Knowledge BaseWebsiteChangelogBook a DemoLogin

Tasks & Projects

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
post
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
patch
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
delete
DELETE /tasks/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}
patch

Update a project

Authorizations
Path parameters
idstringRequired

The ID of the project to update.

Query parameters
namestringOptional

Name for this project

description_htmlstringOptional

Description HTML for this project

customer_portal_visiblebooleanOptional

Customer portal visible for this project

start_datestringOptional

Start date for this project, in RFC 3339 format

end_datestringOptional

End date for this project, in RFC 3339 format

is_archivedbooleanOptional

Whether the project is archived

Body
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

start_datestringOptional

Start date for this project, in RFC 3339 format

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

{
  "customer_portal_visible": true,
  "description_html": "text",
  "end_date": "text",
  "is_archived": true,
  "name": "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",
    "project_template": {
      "id": "text"
    },
    "start_date": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}
delete

Delete an existing project

Authorizations
Path parameters
idstringRequired

The ID of the project to delete.

Responses
200Success
application/json
delete
DELETE /projects/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}
post

Create a project

Authorizations
Query parameters
namestringRequired

Name for this project

description_htmlstringOptional

Description HTML for this project

customer_portal_visiblebooleanOptional

Customer portal visible for this project

Default: false
start_datestringOptional

Start date for this project, in RFC 3339 format

end_datestringOptional

End date for this project, in RFC 3339 format

account_idstringRequired

Account ID for this project

project_template_idstringOptional

Project template ID for this project

Responses
200Success
application/json
post
POST /projects HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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",
    "project_template": {
      "id": "text"
    },
    "start_date": "text",
    "updated_at": "text"
  },
  "request_id": "text"
}
patch

Update a milestone

Authorizations
Path parameters
idstringRequired

The ID of the milestone to update.

Body
due_datestringOptional

Due date for this milestone, in RFC 3339 format

namestringOptional

Name for this milestone

Responses
200Success
application/json
patch
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

Authorizations
Query parameters
namestringRequired

Name for this milestone

due_datestringOptional

Due date for this milestone, in RFC 3339 format

project_idstringRequired

Project ID for this milestone

account_idstringOptional

Account ID for this project

Responses
200Success
application/json
post
POST /milestones HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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

Authorizations
Path parameters
idstringRequired

The ID of the milestone to delete.

Responses
200Success
application/json
delete
DELETE /milestones/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}
PreviousTagsNextTeams

Last updated

Was this helpful?