Sitecore API catalog/Agent API/
/
Update a brief

Update a brief

Request

Partially updates an existing brief using the provided fields. Only the fields included in the request body will be updated; all other existing fields will remain unchanged.

Security
HTTPBearer
Path
brief_idstring(Brief Id)required

The unique identifier of the brief to retrieve. To get this ID, you can use the List briefs endpoint to retrieve the list of briefs in your organization.

Example:brief-1234
Headers
x-sc-job-idany(X-Sc-Job-Id)

A unique identifier for the job, used to trace, audit, and revert actions performed by an AI agent through the Agent API.

Example:job-1234
Bodyapplication/jsonrequired
namestring or null(Name)
Example:"New Summer Campaign Brief"
Any of:

The name of the brief

string
fieldsobject or null(Fields)
Any of:

Dictionary of field names to their values

curl -i -X PUT \
  https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/brief/brief-1234 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-sc-job-id: job-1234' \
  -d '{
    "name": "New Summer Campaign Brief",
    "fields": {
      "property1": {
        "type": "SimpleText",
        "value": "Message"
      },
      "property2": {
        "type": "SimpleText",
        "value": "Message"
      }
    }
  }'

Responses

Successful response

Bodyapplication/json
idstring(Id)

The unique identifier of the brief.

Example:"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
iconstring or null(Icon)
Any of:

The icon associated with the brief.

string
namestring(Name)

The name of the brief.

Example:"New Summer Campaign Brief"
statusstring(Status)

The status of the brief. Draft by default.

Example:"Draft"
localestring(Locale)

The locale code in the format xx-XX.

Example:"en-us"
fieldsobject(Fields)

Dictionary of field names to their values.

isTemplateboolean(Istemplate)
Default:false
contributorsArray of strings or null(Contributors)
Any of:

A list of users who contributed to the brief.

Array of strings
createdByExternalLink (object) or null
Any of:

Represents an external link with reference to external systems

createdOnstring or null(Createdon)
Example:"2026-01-15T10:30:00Z"
Any of:

The ISO 8601 timestamp when the brief was created.

string
updatedByExternalLink (object) or null
Any of:

Represents an external link with reference to external systems

updatedOnstring or null(Updatedon)
Example:"2026-04-01T08:00:00Z"
Any of:

The ISO 8601 timestamp when the brief was last updated.

string
briefTypeBriefTypeLink (object) or null
Any of:
Response
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "icon": "string",
  "name": "New Summer Campaign Brief",
  "status": "Draft",
  "locale": "en-us",
  "fields": {},
  "isTemplate": false,
  "contributors": [
    "string"
  ],
  "createdBy": {
    "type": "ExternalLink",
    "relatedSystem": "ai",
    "relatedType": "Dashboard",
    "id": "dashboard-12345"
  },
  "createdOn": "2026-01-15T10:30:00Z",
  "updatedBy": {
    "type": "ExternalLink",
    "relatedSystem": "ai",
    "relatedType": "Dashboard",
    "id": "dashboard-12345"
  },
  "updatedOn": "2026-04-01T08:00:00Z",
  "briefType": {
    "type": "string",
    "relatedType": "string",
    "id": "string",
    "uri": "string"
  }
}