CUcustomer
Email link and publish

Get publish status

Changed on

Check the status of a multi-language publish that returned "status": "pending". Pass the publish_id from the Publish an email response. When the publish is still running, the response returns "status": "pending"; when it finishes, it returns "status": "done" with the template version mappings.

If the publish fails, this endpoint returns an error rather than a status. You get the same error a single-language publish returns inline—a 422 for liquid errors, a 409 when the destination automation is backfilling, and so on.

get/v1/design_studio/emails/{id}/publish_status

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/design_studio/emails/{id}/publish_status
  • 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.

Query parameters

publish_idstring required

The publish ID returned when a multi-language publish is pending.

Response

Current publish status.

status'pending' | 'done'

pending while the publish is still running; done when it has finished.

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