Skip to main content

CreateStakeHolderResponseBody

Response body for stakeholder creation

uid(string | null)<uuid>nullable

Unique identifier of the created stakeholder (null if creation failed)

Example: 123e4567-e89b-12d3-a456-426614174000
invalidRequest object

Invalid request details (present only if there were validation errors)

oneOf

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)

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

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

  • 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
  • ]
    • errorstring | nullnullable

    Error message (present only if there was an error)

    Example: Your request could not be processed. Please try again later or contact support.
    CreateStakeHolderResponseBody
    {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "invalidRequest": {
        "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",
        "phoneNumbers": "Unknown Type: array,null",
        "emails": "Unknown Type: array,null"
      },
      "error": "Your request could not be processed. Please try again later or contact support."
    }