v1

latestOpenAPI 3.0.12026-07-13139143370.4 KB
Companies

Create Company

Use this endpoint to Create a new authorized company.

Note: Special API Partner credentials are required to access this endpoint.

The name, registrationEmail, phone, country and timezoneName are required fields. For country use the standard ISO 3166 2-character country code.

The timezoneName must be expressed as an IANA Timezone e.g., America/New_York.

For more information: Timezone IANA Wiki

post/setup/v1/companies

Request body

namestring nullable
registrationEmailstring nullable
addressLine1string nullable
addressLine2string nullable
citystring nullable
statestring nullable
postalCodestring nullable
countrystring nullable
phonestring nullable
faxstring nullable
emailstring nullable
websitestring nullable
timezoneNamestring nullable
notificationFromEmailAddressstring nullable
notificationFromNamestring nullable
bookingWebhookUrlstring nullable
customerWebhookUrlstring nullable
reminderWebhookUrlstring nullable
resourceWebhookUrlstring nullable
webhookSignatureHashstring nullable
disableEmailAndSmsNotificationsboolean nullable

Response

Success

objectstring nullable
idstring nullable
namestring nullable
registrationDatestring nullable
registrationEmailstring nullable
deletedStatusboolean
deletedTimestring nullable
addressLine1string nullable
addressLine2string nullable
citystring nullable
statestring nullable
postalCodestring nullable
countrystring nullable
phonestring nullable
faxstring nullable
emailstring nullable
websitestring nullable
timezoneIdstring nullable
timezoneNamestring nullable
notificationFromEmailAddressstring nullable
notificationFromNamestring nullable
clientIdstring nullable
clientSecretstring nullable
bookingWebhookUrlstring nullable
customerWebhookUrlstring nullable
reminderWebhookUrlstring nullable
resourceWebhookUrlstring nullable
webhookSignatureHashstring nullable
disableEmailAndSmsNotificationsboolean