Skip to content

Brands API

Update a brand button

PATCHhttps://email.growthdept.ai/api/brand-buttons/{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_button The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of brand-button 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-button
    • idstringrequired

    • attributesobjectrequired

      attributes: 7 fields
      • namestringcan be null

      • is_primarybooleancan be null

      • preview_page_hexstringcan be null

      • styleobject

      • borderobject

      • spacingobject

      • textobject

    • 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-button
    • idstringrequired

    • attributesobjectrequired

      attributes: 7 fields
      • namestringcan be null

      • is_primarybooleancan be null

      • styleobjectcan be null

        style: 4 fields
        • background_colorstringrequired

        • border_radiusintegerrequired

        • box_shadowstringrequired

        • is_shadow_activeboolean

      • borderobjectcan be null

        border: 4 fields
        • border_colorstringrequired

        • border_stylestringrequired

          dasheddottedsolid
        • border_widthintegerrequired

        • is_border_activeboolean

      • spacingobjectcan be null

        spacing: 4 fields
        • padding_topintegerrequired

        • padding_rightintegerrequired

        • padding_bottomintegerrequired

        • padding_leftintegerrequired

      • textobjectcan be null

        text: 7 fields
        • colorstringrequired

        • font_sizeintegerrequired

        • font_stylestringrequired

          italicnormal
        • font_familystringrequired

        • font_weightintegerrequired

          100200300400500600700800900
        • letter_spacingone ofrequired

          One option: string

          No fields.

          One option: integer

          No fields.

        • text_decorationstringrequired

          line-throughline-through underlinenoneunderlineunderline line-through
      • preview_page_hexstringcan be null

    • 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