Sign in
Design Studio

Create a component

Creates a custom component.

post/v1/design_studio/components

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

Changed in 1 of the 2 revisions of this API.4

  • 5da2740beeb54See the full diff
    • ▲

      the // response's property type changed from integer to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string for status

      response-property-type-changed