Skip to main content

BulkUpsertSubOrganizationRequest

idinteger

System-generated primary key. If provided, the resource is identified and updated using this internal id. Can be used alone or together with externalId (to update the external identifier).

Example: 5538
externalIdstringrequired

Client-provided external identifier. Required when id is not provided. Used as the lookup key for upsert. When id is provided, supplying externalId will update the stored external identifier.

Possible values: <= 255 characters

Example: SUB-ORG
namestringrequired

Official name of the sub-organization

Possible values: <= 255 characters

Example: SUB_ORG_CHECK
externalStatusstringrequired

Status of the sub-organization as defined by the API consumer

Possible values: [active, inactive, awaiting approval, draft, suspended, blacklisted, closed]

Example: closed
typestring

Classification of the sub-organization. Support O(Office) only

Possible values: [O]

Example: O
addressstringrequired

Street address of the sub-organization

Possible values: <= 255 characters

Example: A Street
citystring | nullnullable

City where the sub-organization is located

Possible values: <= 100 characters

Example:
provincestring | nullnullable

Province or state where the sub-organization is located

Possible values: <= 100 characters

Example:
postalCodestring | nullnullable

Postal or ZIP code of the address

Possible values: <= 20 characters

Example:
countrystringrequired

Country where the sub-organization is located (ISO 3166-1 alpha-2)

Possible values: <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: DZ
location object

Geographic coordinates of the sub-organization

latitudenumber,null<double>nullable

The latitude component of the sub-organization's geolocation

Example: null
longitudenumber,null<double>nullable

The longitude component of the sub-organization's geolocation

Example: null
maleEmployeesinteger | nullnullable

Number of male employees

Example: null
femaleEmployeesinteger | nullnullable

Number of female employees

Example: null
solutionsUsedstring[]required

List of solutions used by the sub-organization

Possible values: [Inspection, T&A, Lab Test]

Example: ["Inspection","T&A","Lab Test"]
phoneNumberstring | nullnullable

The phone number of the sub-organization

Possible values: <= 50 characters

Example:
contacts object[]required

List of primary contact persons for the sub-organization

  • Array [
    • firstNamestringrequired

    First name of the contact person

    Possible values: <= 100 characters

    Example: John
    lastNamestring

    Last name of the contact person

    Possible values: <= 100 characters

    Example: Doe
    emailstring<email>required

    Email address of the contact person

    Possible values: <= 255 characters

    phoneNumberstring

    Phone number of the contact person

    Possible values: <= 50 characters

    Example: +1-555-123-4567
    rolestring

    Job title or role of the contact person within the sub-organization, can refer from List Contact Roles API

    Possible values: <= 100 characters

    Example: Manager
  • ]
    • BulkUpsertSubOrganizationRequest
    {
      "id": 5538,
      "externalId": "SUB-ORG",
      "name": "SUB_ORG_CHECK",
      "externalStatus": "closed",
      "type": "O",
      "address": "A Street",
      "city": "",
      "province": "",
      "postalCode": "",
      "country": "DZ",
      "location": {
        "latitude": null,
        "longitude": null
      },
      "maleEmployees": null,
      "femaleEmployees": null,
      "solutionsUsed": [
        "Inspection",
        "T&A",
        "Lab Test"
      ],
      "phoneNumber": "",
      "contacts": []
    }