Update custom field configurations

https://your-domain.atlassian.net/rest/api/3/app/field/{fieldIdOrKey}/context/configuration

Update the configuration for contexts of a custom field created by a Forge app. **Permissions required:** *Administer Jira* global permission. Jira permissions are not required for the Forge app that created the custom field.

Access Token Required: API Key

Path Parameters

fieldIdOrKeystringrequired

The ID or key of the custom field, for example `customfield_10000`.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

curl --request PUT \
     --url 'https://your-domain.atlassian.net/rest/api/3/app/field/{fieldIdOrKey}/context/configuration' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

PUT