Skip to main content

Input fields

consents : [ConsentTypeInput]

Consents to be associated with this contact.

contactAddress : RichAddressInput

The address of the contact.

email : String

The email address of the contact.

extraDetailItems : [ExtraDetailsItem]

Extra details for the contact as key/value pairs.

extraDetails : JSONString

Extra details for the contact.

Deprecation
The 'extraDetails' field is deprecated.

Use `extraDetailsItems` instead, which provides a structured key/value format.

- Marked as deprecated on 2026-01-14.
- Scheduled for removal on or after 2026-07-14.
familyName : String

The family name of the contact.

givenName : String

The given name of the contact.

nationalId : String

The national ID.

phoneNumber : String

The phone number of the contact.

preferredLanguage : String

The preferred language of the contact as an ISO code (e.g. 'es-es').

The roles of the contact.

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

{ "consents": ConsentTypeInput, "contactAddress": RichAddressInput, "email": "real-president-Mr-easy-single", "extraDetailItems": ExtraDetailsItem, "familyName": "Wilson", "givenName": "Dawn", "nationalId": "61940558", "phoneNumber": "bed-behind-spring-and-million", "preferredLanguage": "since-again-teacher-letter-reveal", "roles": "LEGAL_CONTACT" }