Skip to main content

CreateStakeHolderRequestBody

Stakeholder data to create

typestringrequired

Type of stakeholder (person or company)

Example: person
firstNamestring | nullnullable

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

Example: John
lastNamestring | nullnullable

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

Example: Doe
companyNamestring | nullnullable

Company name (required for type=company)

Example: Acme Corporation
sirenstring | nullnullable

SIREN number for company (required for 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[]

Contact details of the company

  • Array [
  • emailstring | nullnullable

    Email address of the contact (required for 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

    Contact active status of the company or person

    faxstring | nullnullable

    Fax of the company

    functionstring | nullnullable

    Function of the person

    CreateStakeHolderRequestBody
    {
    "type": "person",
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "Acme Corporation",
    "siren": "123456789",
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "externalCode": "string",
    "contactsDetails": "Unknown Type: array,null",
    "isActive": true,
    "fax": "string",
    "function": "string"
    }