Create multiple business invitations

Invite multiple suppliers by email to join your commercial network.

Invite multiple users to join your commercial network.

post

Creates multiple BusinessInvitations for a business.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

or

Responses

200

Returns a list of created invitations and any errors encountered. An invitation is only returned when its email was delivered; when delivery fails the invitation is rolled back and the email is listed in the errors map, so it can be retried.

application/json

401Error

403Error

409Error

422Error

post/business-invitations/batch

POST /business-invitations/batch HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "invitations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "sentByUser": {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": "[Circular Reference]",
        "businessId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "firstName": "Paul",
        "lastName": "Smith",
        "locale": "id-ID",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "completed": "false",
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "userInvitations": [
          "[Circular Reference]"
        ],
        "email": "[e-mail]",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false,
          "canManageCmsSupplierRiskAssessmentStatuses": false,
          "canViewCmsSurveys": false,
          "canViewSupplierRiskScore": false
        }
      },
      "business": {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "email": "[e-mail]",
        "name": "Example Inc.",
        "username": "John Doe",
        "addressStreet": "Salawati 143",
        "addressZip": "98451",
        "addressPostcode": "12345",
        "addressArea": "Brandenburg",
        "addressCity": "West Papua",
        "addressCountryCode": "ID",
        "addressCountry": "Indonesia",
        "addressLine1": "Salawati 123",
        "addressLine2": "3rd floor",
        "createdAt": "2023-07-26T15:03:48Z",
        "updatedAt": "2023-07-28T09:13:37Z",
        "initialLocale": "id-ID",
        "units": "metric",
        "plots": [
          "[Circular Reference]"
        ],
        "newlyCreated": "true",
        "members": [
          "[Circular Reference]"
        ],
        "connectionsAsSource": [
          "[Circular Reference]"
        ],
        "connectionsAsTarget": [
          "[Circular Reference]"
        ],
        "businessInvitations": [
          "[Circular Reference]"
        ],
        "contactPerson": {},
        "machineToMachineClientId": "1234567890asdfghjk",
        "eori": "text",
        "vat": "text",
        "tracesEnvironment": "ACCEPTANCE"
      },
      "email": "[e-mail]",
      "status": "PENDING",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z",
      "sourceIsInvitee": "true",
      "customData": {
        "key1": "someValue",
        "key2": true,
        "key3": 1234
      }
    }
  ],
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}