Customer.io
v1.0.0
OpenAPI 3.1.0

Publish an email

US region

Client Libraries
Shell Curl

Publish an email

​

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.

Path Parameters
  • id
    Type: stringFormat: uuid
    required

    The UUID 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.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v1/design_studio/emails/{id}/publish
curl https://api.customer.io/v1/design_studio/emails/123e4567-e89b-12d3-a456-426614174000/publish \
  --request POST

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

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