CUcustomer
Email link and publish

Publish an email

Changed on

Publish a linked Design Studio email. This pushes its current content to the workflow it's linked to. You must link an email to a workflow before you can publish it.

Publishing pushes updates to all language variants: the default language and all of the translations. For a single-language email, the publish runs inline and returns "status": "done" with the resulting template version mappings. For a multi-language email, the publish may take longer; if it doesn't finish within the request window, the response returns "status": "pending" along with a publish_id you can poll with Get publish status.

post/v1/design_studio/emails/{id}/publish

Request

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

Path parameters

idstring uuid required

The id of the email. If your email has multiple languages, you must provide the ID of the default language template. This links the workflow to all of the language variants for the template.

Response

Publish completed (done) or accepted and still running (pending).

status'done' | 'pending'

Returns done when the publish process finished within the request window. Returns pending when publish is still running for a multi-language email (poll with publish_id).

publish_idstring

An opaque ID to poll for completion with Get publish status. Present when status is pending.

Example response

{
  "status": "done",
  "mappings": [
    {
      "node_id": "123e4567-e89b-12d3-a456-426614174000",
      "template_id": 987654,
      "version_id": "v_01H8XK",
      "language": ""
    }
  ]
}

Changes

  • 6378ded43e43Revision changes
    • info

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

    • info

      api tag Email link and publish added

    • info

      api tag Design Studio emails 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

    • info

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