API

Invite Vendors

POST

/v1/invitation-service/invitations

Invites a collection of Vendors to the Topsort platform.

The request payload should contain an array of pairs of vendor’s ID, and email.

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization

required

string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

application/json

object

invites

required

A list of vendors to invite to the Topsort platform. The IDs provided must already exist on the catalog.

Array<object>

>= 1 items <= 500 items

object

vendorEmail

required

The email of the vendor.

string format: email

vendorId

required

The ID of the vendor.

string

Successful Response