Read and replace ticket custom-field values
Use explicit field scopes and versions to keep API edits consistent with staff form validation.
- A formal ticket and the explicit field scopes.
Step-by-step walkthrough
- 01
Request tickets:fields:read with its tickets:read prerequisite. Field writes also require tickets:fields:write and both read scopes.
- 02
Read /ticket-forms to understand the active form layout, field types, options, and conditional requirements.
- 03
Read /tickets/{id}/fields for the current values, ticket version, field version, and form version.
- 04
Send the complete replacement values object with expected_version, expected_fields_version, form_id, and form_version plus a UUID Idempotency-Key.
- 05
Preserve archived values as required and handle validation or version conflicts by rereading the current form and ticket. Form administration itself remains in the staff workspace.
A closer look at the interface
These are actual product captures from a fictional demo workspace. Navigation and available controls can differ by role, configuration, or release.
Developer API workspace
- 1Start with a narrowly scoped API key.
- 2Use the deployment’s real API base URL, not the demo localhost URL.
- 3Download the current contract before implementing write operations.
Expected result
Field updates obey the same form and access rules as staff edits.
Important details
Field scopes can expose information your organization stores in custom fields. Grant them only to trusted integrations.
Need help with this workflow? Contact the team and include this guide’s title.