List template variables | Nexiom Connect

GET/v1/emails/templates/{templateId}/variables

Authorization

Bearer token

Authorizationrequiredheader: Send your API key as Bearer YOUR_API_KEY.
Permissionemail.full_access

Path parameters

templateIdrequiredstring: The template ID.

Response

application/json200 OK

Variables are ordered by key. See Variables for what each field means.

This lists the variables of the draft when the template has one, otherwise of the published version. Sends always use the published version: to see exactly what a send needs while a draft exists, read published_version.variables from Retrieve a template.

curl "https://api-connect.nxiom.com/api/v1/emails/templates/YOUR_TEMPLATE_ID/variables" \
  -H "Authorization: Bearer $NEXIOM_API_KEY"

Set NEXIOM_API_KEY in your environment.

{
  "data": [
    {
      "id": "variable_example",
      "key": "first_name",
      "type": "string",
      "required": true,
      "fallback_value": null
    },
    {
      "id": "variable_example_2",
      "key": "trial_days",
      "type": "number",
      "required": false,
      "fallback_value": 14
    }
  ]
}

Example successful response.

Authorization#

Path parameters#

Response#

Authorization

Path parameters

Response