Skip to main content

Input fields

brandCode : String

The brand code of the company/entity sending the comm. If provided as empty string or the field is not included, it will default to the 'primary' brand.

email : Email

The email address of the recipient.

familyName : String

The family name of the recipient.

givenName : String

The given name of the recipient.

mobile : String

The mobile phone number of the recipient.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "brandCode": "bill-fish-against-power-across", "email": "bparks@example.net", "familyName": "Johnson", "givenName": "Jeffrey", "mobile": "just-many-do-discuss-despite" }