Project milestone statuses

Create project milestone status

post/admin/project_milestone_statuses

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/admin/project_milestone_statuses
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Request body

Example request

{
  "project_milestone_status": {
    "created_at": "2026-09-01 14:22:07",
    "updated_at": "2026-09-01 14:22:07",
    "name": "In Review",
    "hex_color": "#F59E0B",
    "position": 3,
    "status_type": "custom"
  }
}

Response

Successful Response

idinteger

Unique identifier

in_useboolean

Whether any project milestone currently uses this status. Useful for the delete flow — when true, callers must supply merge_into_project_milestone_status_id on DELETE.

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

namestring

The name/label of the milestone status. Must be unique within the account.

hex_colorstring

The color to display the status (hex code with '#' prefix)

positioninteger

Order position in list of statuses. Custom statuses are inserted before the "Done" status by default.

status_type'custom' | 'not_started' | 'in_progress' | 'blocked' | 'done'

The type of status:

  • custom: User-created status. Can be reordered, edited, and deleted.
  • not_started: System status. Cannot be deleted.
  • in_progress: System status. Cannot be deleted.
  • blocked: System status. Cannot be deleted.
  • done: System status. Cannot be deleted.

System statuses are automatically created per account and cannot be deleted (HTTP 403).

Example response

{
  "id": 1,
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "name": "In Review",
  "hex_color": "#F59E0B",
  "position": 3,
  "status_type": "custom"
}

Changes

No recorded changes to this operation across all 1 revision of this API.