Email template usage

If you have questions regarding this API, please visit our API FAQ page.

Before editing or deleting a template in the dashboard, you can check where it is referenced. This endpoint returns the campaigns and contact lists that use a given email template.

Retrieving template usage

Make a GET request to https://webapi.inboxroad.com/api/v2/email-templates/{template_id}/usage/ with a valid X-API-Key (see v2 authentication).

curl -X GET 'https://webapi.inboxroad.com/api/v2/email-templates/{template_id}/usage/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json'

Path parameters

Param name	Description
template_id	Unique identifier of the template (UUID).

Response fields

Each entry is a { "id", "name" } object.

Field name	Description
campaigns	Campaigns that use the template.
welcome_lists	Contact lists that use the template as their welcome email.
doi_lists	Contact lists that use the template as their double opt-in email.

Example response

{
  "campaigns": [
    { "id": "1a2b3c4d-1111-4e91-8a4f-0f17dc6dc5ab", "name": "May Newsletter" }
  ],
  "welcome_lists": [
    { "id": "0fd3d5b4-1c0a-4e91-8a4f-0f17dc6dc5ab", "name": "Newsletter Subscribers" }
  ],
  "doi_lists": []
}

Possible response codes

Status code	Description
200	Template usage retrieved successfully.
401	Unauthorized.
404	Template not found.