Skip to content

Brands API

Update the brand voice

PATCHhttps://email.growthdept.ai/api/brand-voice/{id}

The request body can be up to 5 MB.

Rate limits

Burst: 3/s

Steady: 60/m

Tier S. See rate limits for how requests are counted.

Scopes

brands:write

Operation id

update_brand_voice The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of brand-voice resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      brand-voice
    • idstringrequired

    • attributesobjectrequired

      attributes: 2 fields
      • tone_descriptorsarray of objects

        tone_descriptors: 3 fields
        • namestringrequired

        • descriptionstringrequired

        • user_modifiedbooleancan be null

      • language_patternsarray of objects

        language_patterns: 3 fields
        • namestringrequired

        • descriptionstringrequired

        • user_modifiedbooleancan be null

    • relationshipsobject

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 4 fields
    • typestringrequired

      brand-voice
    • idstringrequired

    • attributesobjectrequired

      attributes: 3 fields
      • versionstringrequired

      • tone_descriptorsarray of objectsrequired

        tone_descriptors: 3 fields
        • namestringrequired

        • descriptionstringrequired

        • user_modifiedboolean

      • language_patternsarray of objectsrequired

        language_patterns: 3 fields
        • namestringrequired

        • descriptionstringrequired

        • user_modifiedboolean

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject