CUcustomer
Components

Create a component

Changed on

Creates a custom component.

post/v1/design_studio/components

Request

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

Request body

namestring required

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

tagstring required

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

parent_folder_idstring uuid nullable

UUID of the parent folder. Omit or pass null to create in the root directory.

contentstring required

HTML content

Example request

{
  "name": "Custom footer",
  "tag": "custom-footer"
}

Response

Component created

Example response

{
  "component": {
    "id": "e89b-12d3",
    "name": "Custom footer",
    "tag": "custom-footer",
    "parent_folder_id": "123e4567-e89b-12d3-a456-426614174000",
    "created": 1773856017
  }
}

Changes

  • 6378ded43e43Revision changes
    • info

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

    • info

      api tag Components added

    • info

      api tag Design Studio removed

  • b0a0db5fbc21Revision changes
    • 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