Skip to main content

CreateStakeHolderRequestBody

Request body for creating a new stakeholder

typestringrequired

Type of stakeholder (person or company)

Example: person
firstNamestring | nullnullable

First name of the person. Required for type=person, optional for a contact attached to a company (parentUid).

Example: John
lastNamestring | nullnullable

Last name of the person, required for type=person. The single name ("Nom du contact") of a contact attached to a company.

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. A person needs one, unless it is a contact attached to a company with a phone number.

    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

    parentUidstring | nullnullable

    Refers to the stakeholder hierarchy only (not the asset perimeter or a contract): uid of this stakeholder's parent company — the mother company for a company, the attachment company for a person

    Example: 030f134a-fb24-4a16-8acb-d29d9ba50077
    isPrimaryContactboolean | nullnullable

    Whether this person is the primary contact of its parent company (stakeholder hierarchy, see parentUid). Requires a parentUid; at most one child per parent, so setting true demotes the current primary contact.

    Example: true
    phoneNumbers object[]

    Qualified phone numbers of the stakeholder

  • Array [
    • valuestringrequired

    Value of the coordinate (phone number or email)

    Example: 0611223344
    typestringrequired

    Qualifier of the coordinate

    Example: Mobile
    isPrimarybooleanrequired

    Whether this is the primary coordinate of its type

    Example: true
  • ]
    • emails object[]

    Qualified emails of the stakeholder. A person needs an email (here or in contactsDetails); a contact attached to a company needs an email or a phone number.

  • Array [
    • valuestringrequired

    Value of the coordinate (phone number or email)

    Example: 0611223344
    typestringrequired

    Qualifier of the coordinate

    Example: Mobile
    isPrimarybooleanrequired

    Whether this is the primary coordinate of its type

    Example: true
  • ]
    • 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",
      "parentUid": "030f134a-fb24-4a16-8acb-d29d9ba50077",
      "isPrimaryContact": true,
      "phoneNumbers": "Unknown Type: array,null",
      "emails": "Unknown Type: array,null"
    }