Format the payload to update Assets Custom Fields via REST API
Platform Notice: Cloud Only - This article only applies to Atlassian apps on the cloud platform.
Summary
Learn how to format the payload to update Jira Assets fields via API. Its format differs from updating other Jira fields via REST API.
Solution
Learn to format the request
The payload below can be used with the same API endpoint to update the Asset custom field.
REST API
curl --request PUT \
--url 'https://your-domain.atlassian.net/rest/api/3/issue/{issueIdOrKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \Payload
{
"update": {
"customfield_XXXXX": [
{
"set": [
{
"workspaceId": "workspaceId ot the Object",
"id": "GlobalId ot the Object (workspaceId:objectId)",
"objectId": "Id of the Object"
}
]
}
]
}
}After the PUT request returns a 200/204 response, follow up with a GET on the same issue and confirm the Assets custom field actually shows the linked object — a malformed but accepted payload can return success while silently failing to link the object.
Workspace ID
The Jira Service Management REST API uses the workspaceId to identify your individual instance of Assets. You must include the workspaceId to make any calls to the REST API.
Use the following endpoint to find your workspaceId:
https://<JSM Premium Site Name>.atlassian.net/rest/servicedeskapi/assets/workspaceFor Assets fields configured to hold multiple objects, include multiple entries inside the set array (one object per entry) rather than making repeated single-object calls, which will overwrite the field's value each time instead of accumulating.
Was this helpful?