Skip to main content

SaveStakeHolderRequestBody

Request body of creating or updating a stakeholder with a specific UID

typestring | nullnullablerequired

Type of stakeholder (person or company)

Default value:
Example: person
uidstring | nullnullable

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

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

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

Default value:
Example: John
lastNamestring | nullnullable

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

Default value:
Example: Doe
companyNamestring | nullnullable

Company name (required of type=company)

Default value:
Example: Acme Corporation
sirenstring | nullnullable

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

Default value:
Example: 123456789
addressstring | nullnullable

Address of the company

Default value:
postalCodestring | nullnullable

Postal code of the company

Default value:
citystring | nullnullable

City of the company

Default value:
externalCodestring | nullnullable

External code of the company

Default value:
contactsDetails object[]required

List of contact details of the stakeholder

  • Array [
    • emailstringrequired

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

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

    Phone number of the contact (not required)

    Default value:
    Example: 0123456789
    additionalInfosstring | nullnullable

    Additional infos of the contact (not required)

    Default value:
  • ]
    • isActivebooleanrequired

    Active status of the stakeholder

    Default value: false
    faxstring | nullnullable

    Fax of the company

    Default value:
    functionstring | nullnullable

    Function of the person

    Default value:
    creationDatestringrequired

    Date of creation of the stakeholder. Accepts a plain date (yyyy-MM-dd) or an ISO 8601 datetime; the time portion, if present, is ignored.

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