Field - Trigger Field Option Sync

The Field endpoint allows you to trigger a Field Option Sync by Get request via the API. This can be useful, for example, if you external events that trigger an important change that should be reflected in Jira as soon as possible.

The general format of the API endpoints is:

CODE

{YOURBASEURL}/api/custom/Field/TriggerSync/{FIELDID}

Variable Parameters:

Base URL

Depending on your data residency settings, you may need to look up {YOURBASEURL} to create the endpoint URL. You’ll find the BaseURL in the Settings tab above the API secret.

Field ID

To update an existing field configuration via API, you need the {FIELDID} of the target field configuration that should be triggered. You will find this ID at the very top of the Field Configuration Edit screen (Field Configuration tab).

Limitations: (might be subject to change)

a maximum of 1 request within 3 minutes
a maximum of 18 requests within 6 hours

Example curl request:

CODE

curl -X GET \
  'https://external-data-for-jira.codefortynine.com/api/custom/Field/TriggerSync/{FIELDID}' \
  -u 'username:password'

Example Postman:

URL

Method GET with generated URL:

Authorization

Basic Auth with username & password: