Projects

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

400Error

application/json

404Error

application/json

patch

HTTPcURLJavaScriptPython

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

400Error

application/json

404Error

application/json

500Error

application/json

delete

HTTPcURLJavaScriptPython

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

400Error

application/json

404Error

application/json

post

HTTPcURLJavaScriptPython

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