Skip to main content

UpdateStakeHolderRequestBody

Request body for partially updating an existing stakeholder (HTTP PATCH)

firstNamestring | nullnullable

First name of the person (only for person stakeholders)

Default value:
Example: John
lastNamestring | nullnullable

Last name of the person (only for person stakeholders)

Default value:
Example: Doe
companyNamestring | nullnullable

Company name (only for company stakeholders)

Default value:
Example: Acme Corporation
sirenstring | nullnullable

SIREN number (only for company stakeholders)

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[]

Contact details list. If present, it REPLACES the existing list.

  • Array [
  • emailstring | nullnullable

    Email address of the contact (optional)

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

    Phone number of the contact (optional)

    Default value:
    Example: 0123456789
    additionalInfosstring | nullnullable

    Additional infos of the contact (optional)

    Default value:
    creationDatestring | nullnullable

    Date of creation of the contact (optional)

    Default value:
    Example: 2020-01-01
  • ]
  • isActiveboolean | nullnullable

    Active flag. If present, it updates the current value.

    Default value: false
    Example: true
    faxstring | nullnullable

    Fax of the company

    Default value:
    functionstring | nullnullable

    Function of the person

    Default value:
    UpdateStakeHolderRequestBody
    {
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "Acme Corporation",
    "siren": "123456789",
    "address": "",
    "postalCode": "",
    "city": "",
    "externalCode": "",
    "contactsDetails": "",
    "isActive": true,
    "fax": "",
    "function": ""
    }