Calendar Event/Task Statuses

Create Calendar Event/Task Status

Create a new calendar entry status for the current account.

New custom statuses are automatically inserted before the "Done" system status. The status_type field defaults to custom and cannot be set to todo or done (system statuses are automatically created per account).

post/admin/calendar_entry_statuses

Request

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

{
  "calendar_entry_status": {
    "created_at": "2026-09-01 14:22:07",
    "updated_at": "2026-09-01 14:22:07",
    "name": "In Progress",
    "position": 2,
    "hex_color": "#DEF7EC",
    "status_type": "custom"
  }
}

Response

Successful Response

idinteger

Unique identifier

in_useboolean

Whether any calendar entry currently uses this status

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 calendar entry status. Must be unique within the account.

positioninteger

Order position in list of statuses. Automatically managed for system statuses (To-Do and Done).

hex_colorstring

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

status_type'custom' | 'todo' | 'done'

The type of status:

  • custom: User-created status (default). Can be reordered, edited, and deleted.
  • todo: System "To-Do" status. Always appears first. Cannot be reordered or deleted.
  • done: System "Done" status. Always appears last. Cannot be reordered or deleted.

System statuses (todo/done) are automatically created and maintained per account.

Example response

{
  "id": 1,
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "name": "In Progress",
  "position": 2,
  "hex_color": "#DEF7EC",
  "status_type": "custom"
}

Changes

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