UPupsmith
authenticated
service-titan-tenant

Add Tenant

Request the ServiceTitan app install for the caller's own organization.

The tenant name is the authenticated organization's, never the client's. Submitting the tenant the organization is already connected to is answered from stored state, so a replay reports the same single request instead of failing.

post/tenants/

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Request body

tenant_idstring required
environment'production' | 'integration'

Which ServiceTitan environment a tenant belongs to.

Three spellings are in play: the API and the onboarding draft use these values, ServiceTitan reports its own capitalised, and the column stores JSON. parse is the only place that reconciles them.

replaceboolean

Response

Successful Response

status'enabled' | 'pending' | 'error' | 'disabled' required
successboolean required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.