Token reference

You can use the email subscribers wizard to specify context-specific tokens in the email subject and body. The tokens available and their replacement values depend on which flow is selected, for example, API, plan, product, or all.

Application Tokens

Tokens that are related to an individual Application.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

Description

[application:description]

The description that is given to the application.

Checkmark Checkmark Checkmark  

Enabled

[application:enabled]

The state that the application is in.

Checkmark Checkmark Checkmark

ID

[application:id]

The ID of the application.

Checkmark Checkmark Checkmark  

Image URL

[application:image_url]

The URL of the image for the application.

Checkmark Checkmark Checkmark  

Lifecycle State

[application:lifecycle_state]

The lifecycle state of the application.

Checkmark Checkmark Checkmark  

Name

[application:name]

The name of the application.

Checkmark Checkmark Checkmark  

Title

[application:title]

The title of the application.

Checkmark Checkmark Checkmark  

Consumer Organization Tokens

Tokens that are related to the individual consumer organization.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

ID

[consumer-org:id]

The ID of the consumer organization.

Checkmark Checkmark Checkmark Checkmark

Name

[consumer-org:name]

The name of the consumer organization.

Checkmark Checkmark Checkmark Checkmark

Title

[consumer-org:title]

The title of the consumer organization.

Checkmark Checkmark Checkmark Checkmark

Product Tokens

Tokens that are related to an individual product.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

APIs

[product:apis]

A comma separated list of APIs (name:version) within the product.

Checkmark Checkmark Checkmark  

ID

[product:id]

The ID of the product.

Checkmark Checkmark Checkmark  

Image URL

[product:image_url]

The URL of the image for the product.

Checkmark Checkmark Checkmark  

Name

[product:name]

The name of the product.

Checkmark Checkmark Checkmark  

Plans

[product:plans]

A comma separated list of plan names within the product.

Checkmark Checkmark Checkmark  

State

[product:state]

The state of the product.

Checkmark Checkmark Checkmark  

Title

[product:title]

The title of the product.

Checkmark Checkmark Checkmark  

Plan Tokens

Tokens that are related to an individual product plan.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

Approval required

[product-plan:approval]

Whether the plan requires approval or not.

  Checkmark    

Description

[product-plan:description]

The description of the plan.

  Checkmark    

Name

[product-plan:name]

The name of a given plan within the product.

Checkmark    

Rate limits

[product-plan:rate-limits]

A comma separated list of rate limit name value pairs that the plan contains.

  Checkmark    

Title

[product-plan:title]

The title of the plan.

  Checkmark    

API Tokens

Tokens that are related to an individual API.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

ID

[api:id]

The ID of the API.

  Checkmark  

Image URL

[api:image_url]

The URL of the image for the API.

    Checkmark  

Name

[api:name]

The name of the API.

  Checkmark  

OAI Version

[api:oai_version]

The OAI version of the API.

    Checkmark  

Protocol

[api:protocol]

The protocol of the API.

    Checkmark  

State

[api:state]

The current state the API is in.

    Checkmark  

Title

[api:title]

The title of the API.

    Checkmark  

Version

[api:version]

The version of the API.

    Checkmark  

User Tokens

Tokens that are related to the individual user account of the recipient.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

Account Name

[user:account-name]

The login name of the user account.

Checkmark Checkmark Checkmark Checkmark

Created

[user:created]

The date the user account was created.

Checkmark Checkmark Checkmark> Checkmark

Display Name

[user:display-name]

The display name of the user account.

Checkmark Checkmark Checkmark Checkmark

Email

[user:mail]

The email address of the user account.

Checkmark Checkmark Checkmark Checkmark

First Name

[user:first_name]

The first name of the user.

Checkmark Checkmark Checkmark Checkmark

Last Name

[user:last_name]

The last name of the user.

Checkmark Checkmark Checkmark Checkmark

Roles

[user:roles]

The user roles associated with the user account.

Checkmark Checkmark Checkmark Checkmark

State

[user:apic_state]

List (text) field.

Checkmark Checkmark Checkmark Checkmark

User ID

[user:uid]

The unique ID of the user account.

Checkmark Checkmark Checkmark Checkmark

Current User Tokens

Tokens that are related to the current user who is initiating the sending of the emails.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

Account name

[current-user:account-name]

The login name of the user account.

Checkmark Checkmark Checkmark Checkmark

Display name

[current-user:display-name]

The display name of the user account.

Checkmark Checkmark Checkmark Checkmark

Email

[current-user:mail]

The email address of the user account.

Checkmark Checkmark Checkmark Checkmark

Site Information Tokens

Tokens that are related to site-wide settings and other global configuration.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

Email

[site:mail]

The administrative email address for the site.

Checkmark Checkmark Checkmark Checkmark

Login page

[site:login-url]

The URL of the site's login page.

Checkmark Checkmark Checkmark Checkmark

Name

[site:name]

The name of the site.

Checkmark Checkmark Checkmark Checkmark

Slogan

[site:slogan]

The slogan of the site.

Checkmark Checkmark Checkmark Checkmark

URL

[site:url]

The URL of the site's front page.

Checkmark Checkmark Checkmark Checkmark

URL (brief)

[site:url-brief]

The URL of the site's front page without the protocol.

Checkmark Checkmark Checkmark Checkmark

Current Date Tokens

Tokens that are related to the current date and time.

Name

Token

Description

Product Subscribers

Plan Subscribers

API Subscribers

All Users

Custom format

[current-date:custom:?]

A date in a custom format. See the PHP documentation for details.

Checkmark Checkmark Checkmark Checkmark

Fallback date format

[current-date:fallback]

A date in 'fallback' format. (Fri, 01/08/2021 - 14:19)

Checkmark Checkmark Checkmark Checkmark

HTML Date

[current-date:html_date]

A date in 'html_date' format. (2021-01-08)

Checkmark Checkmark Checkmark Checkmark

HTML Datetime

[current-date:html_datetime]

A date in 'html_datetime' format. (2021-01-08T14:19:19+0000)

Checkmark Checkmark Checkmark Checkmark

HTML Month

[current-date:html_month]

A date in 'html_month' format. (2021-01)

Checkmark Checkmark Checkmark Checkmark

HTML Time

[current-date:html_time]

A date in 'html_time' format. (14:19:19)

Checkmark Checkmark Checkmark Checkmark

HTML Week

[current-date:html_week]

A date in 'html_week' format. (2021-W01)

Checkmark Checkmark Checkmark Checkmark

HTML Year

[current-date:html_year]

A date in 'html_year' format. (2021)

Checkmark Checkmark Checkmark Checkmark

HTML Yearless date

[current-date:html_yearless_date]

A date in 'html_yearless_date' format. (01-08)

Checkmark Checkmark Checkmark Checkmark

Long format

[current-date:long]

A date in 'long' format. (Friday, January 8, 2021 - 14:19)

Checkmark Checkmark Checkmark Checkmark

Medium format

[current-date:medium]

A date in 'medium' format. (Fri, 01/08/2021 - 14:19)

Checkmark Checkmark Checkmark Checkmark

Raw timestamp

[current-date:raw]

A date in UNIX timestamp format (1610115559)

Checkmark Checkmark Checkmark Checkmark

Short format

[current-date:short]

A date in 'short' format. (01/08/2021 - 14:19)

Checkmark Checkmark Checkmark Checkmark

Time-since

[current-date:since]

A date in 'time-since' format. (6 minutes)

Checkmark Checkmark Checkmark Checkmark