Skip to main content
PATCH
/
api
/
workspace
/
{workspaceId}
/
brands
/
{brandId}
/
ai-specs
Update brand AI specifications
curl --request PATCH \
  --url https://app.alana.shopping/api/workspace/{workspaceId}/brands/{brandId}/ai-specs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tone_of_voice": "<string>",
  "brand_objective": "<string>",
  "target_audience": "<string>",
  "content_policies": "<string>",
  "language_preferences": "<string>",
  "keywords_always": [
    "<string>"
  ],
  "keywords_never": [
    "<string>"
  ],
  "custom_instructions": "<string>"
}
'
{
  "id": "<string>",
  "brand_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "tone_of_voice": "<string>",
  "brand_objective": "<string>",
  "target_audience": "<string>",
  "content_policies": "<string>",
  "language_preferences": "<string>",
  "keywords_always": [
    "<string>"
  ],
  "keywords_never": [
    "<string>"
  ],
  "custom_instructions": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Obtain a token via the authentication endpoint and include it in the Authorization header: Authorization: Bearer <token>

Path Parameters

​
workspaceId
string
required

The workspace ID

​
brandId
string
required

Body

application/json
​
tone_of_voice
string | null
​
brand_objective
string | null
​
target_audience
string | null
​
content_policies
string | null
​
language_preferences
string | null
​
keywords_always
string[] | null
​
keywords_never
string[] | null
​
custom_instructions
string | null

Response

Brand AI specifications updated successfully

​
id
string
required
​
brand_id
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
tone_of_voice
string | null
​
brand_objective
string | null
​
target_audience
string | null
​
content_policies
string | null
​
language_preferences
string | null
​
keywords_always
string[] | null
​
keywords_never
string[] | null
​
custom_instructions
string | null