Skip to main content

Input fields

email : String

Recipient's email.

familyName : String! required

Recipient's family name.

givenName : String! required

Recipient's given name.

mobile : String

Recipient's mobile number.

postalAddress : RichAddressInput

Recipient's postal address.

title : String

Recipient's title.

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

{ "email": "window-against-today-himself-street", "familyName": "Thompson", "givenName": "Jennifer", "mobile": "between-friend-wide-prevent-six", "postalAddress": RichAddressInput, "title": "leave-likely-manage-significant-rich" }