v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-174421106.5 KB

Playbooks

Reorder property fields for a playbook

post/plugins/playbooks/api/v0/playbooks/{id}/property_fields/reorder

Path parameters

idstring required

Example:iz0g457ikesz55dhxcfa0fk9yy

ID of the playbook.

Request body

field_idstring required

ID of the property field to move.

target_positioninteger required

Target position index (zero-based) where the field should be moved.

Example request

{
  "field_id": "p7fj3k2l5m8n9q1r4s6t8v0w2x",
  "target_position": 3
}

Response

Property fields reordered successfully.

idstring

A unique, 26 characters long, alphanumeric identifier for the property field.

type'text' | 'select' | 'multiselect'

The type of the property field.

namestring

The name of the property field.

descriptionstring

The description of the property field.

create_atinteger

The property field creation timestamp, formatted as the number of milliseconds since the Unix epoch.

update_atinteger

The property field update timestamp, formatted as the number of milliseconds since the Unix epoch.

delete_atinteger

The property field deletion timestamp, formatted as the number of milliseconds since the Unix epoch. It equals 0 if not deleted.

attrsobject

Additional attributes for the property field (options for select fields, visibility, etc.).

Example response

[
  {
    "id": "p7fj3k2l5m8n9q1r4s6t8v0w2x",
    "type": "select",
    "name": "Priority",
    "description": "Issue priority level",
    "create_at": 1602235338837,
    "update_at": 1602235338837,
    "attrs": {
      "visibility": "when_set",
      "sortOrder": 1,
      "options": [
        {
          "id": "opt1",
          "name": "High",
          "color": "#ff0000"
        }
      ]
    }
  }
]