Skip to main content
PUT
/
v0
/
style-guides
/
{id}
Update a style guide
curl --request PUT \
  --url https://api.avidoai.com/v0/style-guides/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "content": [
    {
      "heading": "Tone",
      "content": "Use professional and clear language",
      "approved": true
    }
  ]
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "orgId": "org-123",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "content": [
      {
        "heading": "Tone",
        "content": "Use professional and clear language",
        "approved": true
      }
    ],
    "quickstartId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

​
id
string<uuid>
required

The unique identifier of the style guide

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for updating a style guide

​
content
Style Guide Section Input · object[]
required

Response

Successfully updated style guide

Successful response containing the style guide data

​
data
Style Guide · object
required

A style guide for a specific application