Skip to main content
A System Administrator can assign the Fulfillment Operator role to a Tenant Administrator. With this role is assigned, the Tenant Administrator can add other tenants to the system via the Vantage API as well as assign this role to other users in the tenant. To create a tenant via the Vantage API, a Fulfillment Operator needs to do the following:
  1. Authorize in the Vantage API, see Authentication for details.
  2. Send a POST request with the Authorization = Bearer <access token> header to {baseUrl}/api/publicapi/v1/invites/, with the following request body parameters:
ParameterDescription
emailThe newly created Tenant Administrator’s e-mail.
validWithinTime from the moment of sending, during which an invite can be accepted. The format is as follows: days.hours:minutes:seconds. The default value of the parameter is “14.00:00:00” (14 days).
tenantNameThe tenant’s name. Tenant names are unique within the system. If the specified name is already taken by some other tenant, an error will occur when trying to create a new tenant with that same name.
useMySybscriptionSpecifies whether the subscription of the current tenant will be used. If the current tenant’s subscription is used, then both tenants (the current one and the new one) will use pages from the same counter. If one of the tenant uses up all remaining pages of that counter, neither of the tenants will then be able to use it. The default value of the parameter is False, meaning that a new subscription file needs to be downloaded.
tenantDescriptionThe tenant’s description. Any string that describes the tenant. This string will be shown to the System Administrator.
Sample request:

​
For Windows

curl --location --request POST "{baseUrl}/api/publicapi/v1/invites/" 
-H "accept: application/json" \
-H "Authorization: Bearer {token}"
{ 
  "email": "admin@company.tld",
  "validWithin": "14.00:00:00", 
  "tenantName": "tenant's name",
  "useMySubscription": true,
  "tenantDescription": "tenant's description"
}

​
For Linux

curl --location --request POST '{baseUrl}/api/publicapi/v1/invites/'
-H 'accept: application/json' \
-H 'Authorization: Bearer {token}'
{ 
  'email': 'admin@company.tld',
  'validWithin': '14.00:00:00', 
  'tenantName': 'tenant's name',
  'useMySubscription': true,
  'tenantDescription': 'tenant's description'
}