Ticket custom fields

Set a custom field on a ticket

Replaces the ticket's value for one custom field. Send value for a text field and option_ulids for the two select types; sending both, or the wrong one for the field's type, is a validation error. An empty value and an empty option_ulids clears the field. Returns 404 when the field belongs to another workspace or is not available on the ticket's channel. Read the current values from GET /tickets/{ticket}, which returns the fields that apply to the ticket whether or not they hold a value.

put/tickets/{ticket}/custom-fields/{customField}

Request

  • Base URL: https://there-there.app/api
  • URL: https://there-there.app/api/tickets/{ticket}/custom-fields/{customField}
  • Auth: HTTP bearer

Path parameters

ticketstring required

Ticket ULID.

customFieldstring required

Custom field ULID.

Headers

X-Workspace-Idinteger

Workspace ID this request targets. Required for tokens that have access to multiple workspaces or to all workspaces. Optional for tokens scoped to a single workspace (auto-resolved). Find the ID under Settings > Account > API Tokens or Settings > Workspace > General.

Request body

valuestring nullable required

The text for a text field, or null. Must be null for select fields.

option_ulidsstring[] required

The option ULIDs that should end up selected, which replaces the current selection rather than adding to it. At most one for a single-select field. Must be empty for text fields.

Example request

{
  "value": "1.2.3"
}

Response

Updated ticket, including its custom fields

Example response

{
  "data": {
    "custom_fields": [
      {
        "name": "Reported version",
        "options": [
          {
            "name": "Laravel",
            "color": "#FCA5A5",
            "icon": "flame"
          }
        ]
      }
    ]
  }
}

Changes

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