Skip to main content

SaveStakeHolderRequestBody

Stakeholder data to save

typestring | nullnullablerequired

Type of stakeholder (person or company)

Example: person
uidstring | nullnullable

Unique identifier of the stakeholder (must match the path parameter)

Example: 123e4567-e89b-12d3-a456-426614174000
firstNamestring | nullnullable

First name of the person (required of type=person)

Example: John
lastNamestring | nullnullable

Last name of the person (required of type=person)

Example: Doe
companyNamestring | nullnullable

Company name (required of type=company)

Example: Acme Corporation
sirenstring | nullnullable

SIREN number of the company (required of type=company)

Example: 123456789
addressstring | nullnullable

Address of the company

postalCodestring | nullnullable

Postal code of the company

citystring | nullnullable

City of the company

externalCodestring | nullnullable

External code of the company

contactsDetails object[]required

List of contact details of the stakeholder

  • Array [
  • emailstringrequired

    Email address of the contact (required of type=person/company)

    Example: john.doe@example.com
    phoneNumberstring | nullnullable

    Phone number of the contact (not required)

    Example: 0123456789
    additionalInfosstring | nullnullable

    Additional infos of the contact (not required)

  • ]
  • isActivebooleanrequired

    Active status of the stakeholder

    faxstring | nullnullable

    Fax of the company

    functionstring | nullnullable

    Function of the person

    creationDatestringrequired

    Date of creation of the stakeholder

    Example: 2021-01-01T00:00:00Z
    SaveStakeHolderRequestBody
    {
    "type": "person",
    "uid": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "Acme Corporation",
    "siren": "123456789",
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "externalCode": "string",
    "contactsDetails": [
    {
    "email": "john.doe@example.com",
    "phoneNumber": "0123456789",
    "additionalInfos": "string"
    }
    ],
    "isActive": true,
    "fax": "string",
    "function": "string",
    "creationDate": "2021-01-01T00:00:00Z"
    }