Skip to main content

Recipient

FieldTypeRequiredDescription
typeStringoptionalCould be: entity or person.
Default to person
titleStringoptionalRecipient title or the company name when type is entity
firstNameStringmandatoryRecipient firstName or an optional recipient name when type is entity
lastNameStringmandatoryNot used when type is entity
addressAddressmandatory

Exemple

Required fields only

{
"firstName": "Martin",
"lastName": "BRON",
"address": {
"street": "Street 30",
"zip": "1400",
"city": "Yverdon-les-Bains"
}
}

All fields

{
"type": "person",
"title": "Madame",
"firstName": "Martine",
"lastName": "BRON",
"address":{
"street": "Street 30",
"zip": "75000",
"city": "Paris",
"countryCode": "FR"
}
}
{
"type": "entity",
"title": "OptaMed",
"firstName": "Marketing department",
"lastName": "",
"address":{
"street": "Street 30",
"zip": "75000",
"city": "Paris",
"countryCode": "FR"
}
}