Migration of the endpoint PUT /v2/proposals/{proposal_id}/attendees to PUT /v3/proposals/{proposal_id}/attendees
- Outdated
- October 22, 2025
- 1 related route
Context
Upgrade from PUT - /v2/proposals/{proposal_id}/attendees to PUT - /v3/proposals/{proposal_id}/attendees
⭐ 3 Key benefits :
- Uniformize the PUT -
/v3/proposals/{proposal_id}/attendeestravel_documents model to the travel documents endpoints : GET -/v1/customers/{customer_id}/travel_documents& PATCH -/v1/customers/{customer_id}/travel_documents, which use travel document objects instead of a unique travel_documents array - Add specific fields for each type of travel document
- second_name, third_name, fourth_name, unicode_second_name, unicode_third_name & unicode_fourth_name to the passport
- birth_city to passport, id_card and visas (required in case of Turkish stays)
- Remove unused fields for driving_licence
Impacts
Route to call :
- PUT -
/v3/proposals/{proposal_id}/attendees
Input became
[
{
"address": {
"number": "15",
"street": "AVENUE DES CHAMPS ELYSEES",
"add_on": "6A",
"town": "Luynes",
"city": "Aix-en-Provence",
"zip_code": "75000",
"state_or_district": "CA",
"country": "FRANCE",
"country_code": "FR",
"additional_information_1": "Chez M. Dupont",
"additional_information_2": "Entreprise Clubmed"
},
"attendees": [
{
"id": "A",
"customer_id": "123456789",
"first_name": "Marc",
"unicode_first_name": "北",
"last_name": "Dupont",
"unicode_last_name": "王",
"email": "bei.wang@123.com",
"civility_code": "MR",
"health_pass_id": "1234567892",
"identity": {
"number": "E001241",
"type": "TAX_NUMBER"
},
"birthdate": "2022-04-15",
- "travel_documents": [
- {
- "document_number": "09PR5121F",
- "type": "PASSPORT"
- "expiration_date": "20281015",
- "issuing_date": "20181015",
- "nationality": "FR",
- "issuing_country": "FR",
- "birth_country": "FR",
- "authority": "Prefecture de Torcy"
- }
- ],
"travel_documents": {
"passport": {
"document_number": "09PR5121F",
"expiration_date": "20281015",
"issuing_date": "20181015",
"nationality": "FR",
"issuing_country": "FR",
"birth_country": "FR",
+ "birth_city": "Versailles",
"authority": "Prefecture de Torcy"
+ "second_name": "Richard",
+ "unicode_second_name": "Richard",
+ "third_name": "Arthur",
+ "unicode_third_name": "Arthur",
+ "fourth_name": "Charles",
+ "unicode_fourth_name": "Charles",
},
"id_card": {
"document_number": "09PR5121F",
"expiration_date": "20281015",
"issuing_date": "20181015",
"nationality": "FR",
"issuing_country": "FR",
"birth_country": "FR",
+ "birth_city": "Versailles",
"authority": "Prefecture de Torcy"
},
"visas": [
{
"document_number": "09PR5121F",
"expiration_date": "20281015",
"issuing_date": "20181015",
"nationality": "FR",
"issuing_country": "FR",
"birth_country": "FR",
+ "birth_city": "Versailles",
"category": "ESTA",
"authority": "Prefecture de Torcy"
}
],
"driving_licence": {
"document_number": "09PR5121F",
"expiration_date": "20281015",
"issuing_date": "20181015",
"issuing_country": "FR",
"authority": "Prefecture de Torcy"
}
},
"phones": [
{
"number": "0623456789",
"type": "MOBILE"
}
],
"optins": [
{
"channel": "EMAIL",
"optin": true,
"optin_partners": true
}
]
}
],
"language_code": "FR"
}
]
Model
| field name | field type | Description | Example value |
|---|---|---|---|
| attendees.travel_documents.passport.birth_city | string | customer birth city | Versailles |
| attendees.travel_documents.id_card.birth_city | string | customer birth city | Versailles |
| attendees.travel_documents.visas.birth_city | string | customer birth city | Versailles |
| attendees.travel_documents.passport.second_name | string | customer profile second name | Richard |
| attendees.travel_documents.passport.unicode_second_name | string | customer profile unicode second name, if relevant | Richard |
| attendees.travel_documents.passport.third_name | string | customer profile third name | Arthur |
| attendees.travel_documents.passport.unicode_third_name | string | customer profile unicode third name, if relevant | Arthur |
| attendees.travel_documents.passport.fourth_name | string | customer profile fourth name | Charles |
| attendees.travel_documents.passport.unicode_fourth_name | string | customer profile unicode fourth name, if relevant | Charles |