Deal statuses

Create deal status

post/admin/deal_statuses

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/admin/deal_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

{
  "deal_status": {
    "created_at": "2026-09-01 14:22:07",
    "updated_at": "2026-09-01 14:22:07",
    "name": "Blue",
    "hex_color": "0000FF",
    "position": 1
  }
}

Response

Successful Response

idinteger

Unique identifier

editableboolean

Is the deal status editable

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 label/name of the deal status

hex_colorstring

The color to display the lead status (hex code without the '#')

positioninteger

The position in a list that this deal status should appear in

Example response

{
  "id": 1,
  "editable": true,
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "name": "Blue",
  "hex_color": "0000FF",
  "position": 1
}

Changes

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