Components

Update a component

Changed on

Update part of a component: its name, tag, folder, or content.

put/v1/design_studio/components/{id}

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/design_studio/components/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The UUID of the component.

Request body

namestring

Display name of the component. You see this on your Design Studio dashboard. This may be different from the component tag name.

tagstring

The component tag name, used to reference your component in an email. Learn what characters you can use.

parent_folder_idstring uuid nullable

The UUID of the parent folder.

Omit if you want no change to where the folder or file is located. Include null to move it to your root directory. Or add the UUID of another folder to move it there.

contentstring

HTML content

Example request

{
  "name": "custom-footer"
}

Response

Component updated

Changes

    • info

      the endpoint scheme security Bearer-Auth was added to the API

    • info

      api tag Components added

    • info

      api tag Design Studio removed

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status