Skip to main content
PUT
/
v0
/
style-guides
/
{id}
JavaScript
import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
});

const styleGuide = await client.styleGuides.update('123e4567-e89b-12d3-a456-426614174000', {
  content: [{ content: 'Use professional and clear language', heading: 'Tone' }],
});

console.log(styleGuide.data);
{
  "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

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
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