Sign in

v46

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

Set a property value for a playbook run

put/plugins/playbooks/api/v0/runs/{id}/property_fields/{field_id}/value

Path parameters

idstring required
Example:mx3xyzdojfgyfdx8sc8of1gdme

ID of the playbook run to set property value for.

field_idstring required
Example:p7fj3k2l5m8n9q1r4s6t8v0w2x

ID of the property field to set value for.

Request body

valuestring json required

The JSON-encoded value to set for the property.

Example request

{
  "value": "\"High Priority Issue\""
}

Response

Property value set successfully.

idstring

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

field_idstring

The identifier of the property field this value belongs to.

valuestring json

The JSON-encoded value of the property.

create_atinteger

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

update_atinteger

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

delete_atinteger

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

Example response

{
  "id": "v8z9a1b2c3d4e5f6g7h8i9j0k1l",
  "field_id": "p7fj3k2l5m8n9q1r4s6t8v0w2x",
  "value": "\"High Priority\"",
  "create_at": 1602235338837,
  "update_at": 1602235338837
}