Inbox

Change a stage

Rename, describe, recolor, hide or show a stage. Built-in statuses can only be hidden or shown; neutral always stays visible.

CostWhat it doesKey scopes
FreeWritesargorant:manage_lists
patch/api/v1/reply-statuses/{key}

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/reply-statuses/{key}
  • Auth: HTTP bearer

Path parameters

keystring required

The status key.

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

labelstring

New name.

color'lime' | 'blue' | 'rose' | 'neutral' | 'purple' | 'yellow'

New color.

descriptionstring

New description.

visibleboolean

Show or hide in the app.

Response

OK

Changes

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