USusepylon
projects

Update a project

Changed on

Updates an existing project. Only provided fields are modified.

Rate limit: 300 requests per minute

patch/projects/{id}

Request

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

Path parameters

idstring required

The ID of the project to update.

Request body

ai_instructionsstring

Instructions the AI follows when keeping this smart project up to date. Set to an empty string to clear them.

customer_portal_visibleboolean

Customer portal visible for this project

description_htmlstring

Description HTML for this project

end_datestring

End date for this project, in RFC 3339 format. Set to an empty string to clear it.

is_archivedboolean

Whether the project is archived

namestring

Name for this project

owner_idstring

Owner ID for this project

start_datestring

Start date for this project, in RFC 3339 format. Set to an empty string to clear it.

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