Create a business invitation

Send a business invitation via mail to a supplier to join your commercial network.

Invite a business to join your commercial network.

post

Creates a business invitation, which represents an invitation to a business to join your commercial network so that you can get access to their data.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
emailstringRequired

email of the user representing the business that this invitation is for

Example: [email protected]
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
post
/business-invitations
PreviousBusiness invitationsNextCreate multiple business invitations

Last updated