CreateStakeHolderRequestBody
Request body for creating a new stakeholder
typestringrequired
Type of stakeholder (person or company)
Default value:
##defaultExample:
personfirstNamestring
First name of the person (required for type=person)
Default value:
##defaultExample:
JohnlastNamestring
Last name of the person (required for type=person)
Default value:
##defaultExample:
DoecompanyNamestring
Company name (required for type=company)
Default value:
##defaultExample:
Acme Corporationsirenstring
SIREN number for company (required for type=company)
Default value:
##defaultExample:
123456789addressstring
Address of the company
Default value:
##defaultpostalCodestring
Postal code of the company
Default value:
##defaultcitystring
City of the company
Default value:
##defaultexternalCodestring
External code of the company
Default value:
##defaultcontactsDetails object[]
Contact details of the company
Array [
emailstring
Email address of the contact (required for type=person/company)
Default value:
##defaultExample:
john.doe@example.comphoneNumberstring
Phone number of the contact (not required)
Default value:
##defaultExample:
0123456789additionalInfosstring
Additional infos of the contact (not required)
Default value:
##default]
isActiveboolean
Contact active status of the company or person
Default value:
falsefaxstring
Fax of the company
Default value:
##defaultfunctionstring
Function of the person
Default value:
##defaultCreateStakeHolderRequestBody
{
"type": "person",
"firstName": "John",
"lastName": "Doe",
"companyName": "Acme Corporation",
"siren": "123456789",
"address": "##default",
"postalCode": "##default",
"city": "##default",
"externalCode": "##default",
"contactsDetails": [
{
"email": "john.doe@example.com",
"phoneNumber": "0123456789",
"additionalInfos": "##default"
}
],
"isActive": false,
"fax": "##default",
"function": "##default"
}