Recipient
| Field | Type | Required | Description |
|---|---|---|---|
type | String | optional | Could be: entity or person.Default to person |
title | String | optional | Recipient title or the company name when type is entity |
firstName | String | mandatory | Recipient firstName or an optional recipient name when type is entity |
lastName | String | mandatory | Not used when type is entity |
address | Address | mandatory |
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"
}
}