TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Provide and Review Documents
    • Assess risk in your supply chain
    • Manage your transactions
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Webhooks Guide
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Assess risk in your supply chain
    • Manage your transactions
    • API reference
      • Auth
      • Plots
        • Analyses of a specific Plot
        • Batch
      • Analyses
      • Attachments
      • Business invitations
        • Create a business invitation
        • Create multiple business invitations
        • Update a business invitation
        • List all received invitations
        • List all sent invitations
      • Business connections
      • Transactions
        • Create a Transaction
        • Retrieve Transactions
          • Get a transaction by id
          • List all transactions
        • Modify an existing Transaction
          • Update a Transaction
          • Add a Transaction Component
          • Update a Transaction Component
          • Delete a Transaction Component
        • Delete a Transaction
        • Submit a Transaction
        • Retrieve DDS Data
      • Risk Assessments
        • Supplier Risk Assessments
          • Create a Supplier Risk Assessment
          • Update a Supplier Risk Assessment
          • Retrieve Supplier Risk Assessments
            • Get a supplier risk assessment by id
            • Get all supplier risk assessments
          • Retrieve the history
        • Plot Risk Assessments
          • Create a Plot Risk Assessment
          • Update a Plot Risk Assessment
          • Retrieve Plot Risk Assessments
            • Get a plot risk assessment by id
            • Get all plot risk assessments
          • Retrieve the history
      • Survey responses
      • Health
      • Version
      • Specification
  • Additional Resources
    • FAQs
    • Contact Support
    • Terms and Conditions
Powered by GitBook
On this page
  1. Using the TradeAware API
  2. API reference
  3. Business invitations

Update a business invitation

PreviousCreate multiple business invitationsNextList all received invitations

Last updated 1 day ago

Update a business invitation.

patch

Update the properties of the specified business invitation. Handles updates partially, i.e. properties missing in the request body will not be changed. Use this endpoint to update the status of the business invitation, i.e. to ACCEPTED or REJECTED.

If you have sent the invitation, you can also cancel it with this endpoint and the status CANCELLED.

Authorizations
Path parameters
idstringRequired
Body
statusall ofRequired

new status for this invitation

string · enumOptionalPossible values:
customDataobjectOptional

A customizable metadata field for storing additional information related to a business invitation in TradeAware. This field allows customers to associate their own identifiers or data with TradeAware's system.

  The `customData` field is returned unchanged and is visible only to the owners of the business invitation.

  Constraints:
    - Up to 10 keys per object
    - Key length: Maximum 255 characters
    - String value length: Maximum 255 characters
    - Values must be of type: string, number, or boolean
    - Nested objects are not allowed
    - Keys cannot contain: '__proto__', 'constructor', or 'prototype'
Example: {"key1":"someValue","key2":true,"key3":1234}
Responses
200Success
application/json
401Error
403Error
404Error
409
409 Conflict when the business connection already exists between the two businesses
422Error
501
501 Not Implemented when the feature is not enabled on this environment.
patch
PATCH /business-invitations/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "status": "PENDING",
  "customData": {
    "key1": "someValue",
    "key2": true,
    "key3": 1234
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "sentByUser": {
    "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
    "business": {
      "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
      "email": "user@example.com",
      "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": "[Circular Reference]",
      "machineToMachineClientId": "1234567890asdfghjk",
      "eori": "text",
      "vat": "text"
    },
    "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": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sentByUser": "[Circular Reference]",
        "business": "[Circular Reference]",
        "email": "user@example.com",
        "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
        }
      }
    ],
    "userInvitations": [
      {
        "id": "text",
        "email": "some@email.com",
        "sentByUser": "[Circular Reference]",
        "status": "ACCEPTED",
        "createdAt": "2020-01-01T00:00:00.000Z",
        "updatedAt": "2020-01-01T00:00:00.000Z"
      }
    ],
    "email": "user@example.com",
    "consentedAt": "2023-07-28T09:13:37Z",
    "entitlements": {
      "canTriggerPrecisionAnalysis": false,
      "canManageTransactions": false,
      "canViewSurveys": false,
      "canViewOwnedSurveyResponses": true,
      "canViewSurveyResponsesOfTier1Suppliers": false,
      "canMutateOwnedSurveyResponses": false,
      "canDownloadSurveyResponses": false,
      "canManageWebhooks": false,
      "canAccessApi": false
    }
  },
  "business": {
    "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
    "email": "user@example.com",
    "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": [
      {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "createdAt": "2023‐07‐26T15:03:48Z",
        "updatedAt": "2023‐07‐28T09:13:37Z",
        "suppliers": [
          "[Circular Reference]"
        ],
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                100,
                0
              ],
              [
                100.01,
                0
              ],
              [
                100.01,
                0.01
              ],
              [
                100,
                0.01
              ],
              [
                100,
                0
              ]
            ]
          ]
        },
        "commodities": [
          "oil palm",
          "rubber"
        ],
        "name": "text",
        "surfaceArea": 1,
        "countryCode": "text",
        "mostRecentAnalysis": {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "createdAt": "2023-07-26T15:03:48Z",
          "updatedAt": "2023-07-28T09:13:37Z",
          "status": "started",
          "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "analysedAt": "2023-07-28T09:13:37Z",
          "version": "open-source-1.0.0",
          "deforestedArea": 123.45,
          "deforestedGeometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  13,
                  52.5
                ],
                [
                  13.5,
                  52.5
                ],
                [
                  13.5,
                  52
                ],
                [
                  13,
                  52
                ],
                [
                  13,
                  52.5
                ]
              ]
            ]
          },
          "riskOfDeforestation": 0.3,
          "type": "EUFOROBS",
          "metadata": {
            "some": "metadata"
          },
          "name": "text"
        },
        "mostRecentAnalysesByType": {
          "EUFOROBS": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "started",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "EUFOROBS",
            "metadata": {
              "some": "metadata"
            },
            "name": "text"
          },
          "PRECISION": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "createdAt": "2023-07-26T15:03:48Z",
            "updatedAt": "2023-07-28T09:13:37Z",
            "status": "started",
            "plotId": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "analysedAt": "2023-07-28T09:13:37Z",
            "version": "open-source-1.0.0",
            "deforestedArea": 123.45,
            "deforestedGeometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    13,
                    52.5
                  ],
                  [
                    13.5,
                    52.5
                  ],
                  [
                    13.5,
                    52
                  ],
                  [
                    13,
                    52
                  ],
                  [
                    13,
                    52.5
                  ]
                ]
              ]
            },
            "riskOfDeforestation": 0.3,
            "type": "EUFOROBS",
            "metadata": {
              "some": "metadata"
            },
            "name": "text"
          }
        },
        "filename": {},
        "description": "text",
        "ownerId": "text",
        "customData": {
          "key1": "someValue",
          "key2": true,
          "key3": 1234
        }
      }
    ],
    "newlyCreated": "true",
    "members": [
      {
        "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
        "business": {
          "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
          "email": "user@example.com",
          "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": "[Circular Reference]",
          "machineToMachineClientId": "1234567890asdfghjk",
          "eori": "text",
          "vat": "text"
        },
        "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": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "sentByUser": "[Circular Reference]",
            "business": "[Circular Reference]",
            "email": "user@example.com",
            "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
            }
          }
        ],
        "userInvitations": [
          {
            "id": "text",
            "email": "some@email.com",
            "sentByUser": "[Circular Reference]",
            "status": "ACCEPTED",
            "createdAt": "2020-01-01T00:00:00.000Z",
            "updatedAt": "2020-01-01T00:00:00.000Z"
          }
        ],
        "email": "user@example.com",
        "consentedAt": "2023-07-28T09:13:37Z",
        "entitlements": {
          "canTriggerPrecisionAnalysis": false,
          "canManageTransactions": false,
          "canViewSurveys": false,
          "canViewOwnedSurveyResponses": true,
          "canViewSurveyResponsesOfTier1Suppliers": false,
          "canMutateOwnedSurveyResponses": false,
          "canDownloadSurveyResponses": false,
          "canManageWebhooks": false,
          "canAccessApi": false
        }
      }
    ],
    "connectionsAsSource": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sourceBusiness": "[Circular Reference]",
        "targetBusiness": "[Circular Reference]",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "customData": {
          "foo": "bar"
        },
        "plotsCount": 1,
        "plotsCommodities": [
          "cattle",
          "cocoa"
        ]
      }
    ],
    "connectionsAsTarget": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sourceBusiness": "[Circular Reference]",
        "targetBusiness": "[Circular Reference]",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "customData": {
          "foo": "bar"
        },
        "plotsCount": 1,
        "plotsCommodities": [
          "cattle",
          "cocoa"
        ]
      }
    ],
    "businessInvitations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "sentByUser": {
          "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
          "business": {
            "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
            "email": "user@example.com",
            "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": "[Circular Reference]",
            "machineToMachineClientId": "1234567890asdfghjk",
            "eori": "text",
            "vat": "text"
          },
          "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": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "sentByUser": "[Circular Reference]",
              "business": "[Circular Reference]",
              "email": "user@example.com",
              "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
              }
            }
          ],
          "userInvitations": [
            {
              "id": "text",
              "email": "some@email.com",
              "sentByUser": "[Circular Reference]",
              "status": "ACCEPTED",
              "createdAt": "2020-01-01T00:00:00.000Z",
              "updatedAt": "2020-01-01T00:00:00.000Z"
            }
          ],
          "email": "user@example.com",
          "consentedAt": "2023-07-28T09:13:37Z",
          "entitlements": {
            "canTriggerPrecisionAnalysis": false,
            "canManageTransactions": false,
            "canViewSurveys": false,
            "canViewOwnedSurveyResponses": true,
            "canViewSurveyResponsesOfTier1Suppliers": false,
            "canMutateOwnedSurveyResponses": false,
            "canDownloadSurveyResponses": false,
            "canManageWebhooks": false,
            "canAccessApi": false
          }
        },
        "business": "[Circular Reference]",
        "email": "user@example.com",
        "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
        }
      }
    ],
    "contactPerson": {
      "auth0UserId": "auth0|41ba-aa49-f114ca4c263f",
      "business": {
        "id": "02c36247-1aad-41ba-aa49-f114ca4c263f",
        "email": "user@example.com",
        "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": "[Circular Reference]",
        "machineToMachineClientId": "1234567890asdfghjk",
        "eori": "text",
        "vat": "text"
      },
      "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": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "sentByUser": "[Circular Reference]",
          "business": "[Circular Reference]",
          "email": "user@example.com",
          "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
          }
        }
      ],
      "userInvitations": [
        {
          "id": "text",
          "email": "some@email.com",
          "sentByUser": "[Circular Reference]",
          "status": "ACCEPTED",
          "createdAt": "2020-01-01T00:00:00.000Z",
          "updatedAt": "2020-01-01T00:00:00.000Z"
        }
      ],
      "email": "user@example.com",
      "consentedAt": "2023-07-28T09:13:37Z",
      "entitlements": {
        "canTriggerPrecisionAnalysis": false,
        "canManageTransactions": false,
        "canViewSurveys": false,
        "canViewOwnedSurveyResponses": true,
        "canViewSurveyResponsesOfTier1Suppliers": false,
        "canMutateOwnedSurveyResponses": false,
        "canDownloadSurveyResponses": false,
        "canManageWebhooks": false,
        "canAccessApi": false
      }
    },
    "machineToMachineClientId": "1234567890asdfghjk",
    "eori": "text",
    "vat": "text"
  },
  "email": "user@example.com",
  "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
  }
}