v1

latestOpenAPI 3.1.02026-08-0662251219.8 KB
Companies

Create company

This endpoint creates a company. This is allowed only by TMC_ADMIN and above roles.

post/v2/companies

Request body

namestring required

Company name

emailDomainsstring[]

List of the company email domains

billingCurrencystring required

Billing currency of the company

isSelfSignUpEnabledboolean

Boolean to show if company has self sign up enabled.

companyRolesCompanyRole[] required

Company roles

ccEmailAddressesstring[]

List of email addresses on which all confirmation emails will be cced. This is applicable only for company roles 'ORG'

bccEmailAddressesstring[]

List of email addresses on which all confirmation emails will be bcced. This is applicable only for company roles 'ORG'

redirectUrlstring

Redirect URL for the company. It is applicable only for company roles 'PARTNER_TMC'

mobileRedirectUrlstring

Redirect URL for the company for mobile. It is applicable only for company roles 'PARTNER_TMC'

applicableCustomFieldTypesCustomFieldType[]

List of custom fields supported by the company.

externalIdstring

External id for legal entity.

isFakeboolean

Whether the company is a fake company for testing. This is for internal use.

loyaltyBlockedCountriesstring[]

List of 2 letter country codes where business travelers should not be allowed to add loyalty info.

allowDomainBasedAuthConfigboolean

Whether to allow user to get auth config based on email domain

Response

Created

idstring uuid required

Example response

{
  "id": "b93dc51f-12dd-46c7-b7d6-1cb12cd3f5b3"
}