USusepylon
projects

Create a project

Changed on

Creates a new project for an account. Provide a name or project_template_id. A template supplies defaults; non-empty name and description_html values and supplied ai_instructions, customer_portal_visible, and owner_id values override them. Supplying either start_date or end_date replaces both template dates.

Rate limit: 300 requests per minute

post/projects

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/projects
  • Auth
    HTTP bearer

Request body

account_idstring required

Account ID for this project

ai_instructionsstring

Instructions the AI follows when keeping this smart project up to date. Overrides the template's instructions when provided.

customer_portal_visibleboolean

Customer portal visible for this project

description_htmlstring

Description HTML for this project

end_datestring date-time

End date for this project, in RFC 3339 format

namestring

Name for this project. Required unless project_template_id is provided. When both are provided, this name overrides the template's name.

owner_idstring

Owner ID for this project

project_template_idstring

Project template ID for this project. When provided, it supplies defaults; non-empty name and description_html values and supplied ai_instructions, customer_portal_visible, and owner_id values override them. Supplying either start_date or end_date replaces both template dates.

start_datestring date-time

Start date for this project, in RFC 3339 format

Response

request_idstring required

The request ID for tracking.

Example response

{
  "data": {
    "custom_fields": {
      "health": {
        "value": "on_track"
      }
    }
  }
}

Changes

  • 554844ef05a1Revision changes
    • info

      added the new optional request property

    • info

      added the required property / to the response with the status

  • 40bf3229d58fRevision changes
    • info

      the response property became required for the status