POST
/
v2
/
agencies

Authorizations

Authorization
string
header
required

Workspace secret API key, found in the workspace settings page (top left).

Body

application/json
name
string
required

The name of the agency.

address
string

Address of the agency.

brandingText
string

Text for agency branding (supports markdown).

customCSS
string

Custom CSS for the agency to inject on the dashboard.

customDomain
string

(Edit only from dashboard) Custom domain for the agency.

customThemeJSONString
object

MUST JSON.stringify() this object before passing it to the API.

Custom theme object for the agent

darkModeSquarePhotourl
string

URL to the agency's dark mode square photo.

enableHumanHandoff
boolean

Indicates if human handoff is enabled.

googleFont
string

Google font used by the agency Browse fonts

isVerifiedCustomDomain
boolean

Indicates if the custom domain is verified.

isVerifiedSubDomain
boolean

Indicates if the subdomain is verified.

mainWebsite
string

Main website URL for the agency.

OPENAI_API_KEY
string

API key for OpenAI.

OPENAI_DEFAULT_MODEL
enum<string>

Default OpenAI model for the agency.

Available options:
gpt-3.5-turbo,
gpt-4-1106-preview
privacyPolicypPage
string

Privacy policy page URL.

resendEmailDomain
string

Domain for resend email.

resendEmailDomainId
string

Identifier for the resend email domain.

resendEmailDomainRecords_JSON_STRING
string

JSON string representing resend email domain records.

resendEmailDomainStatus
enum<string>

Status of the resend email domain.

Available options:
not_started,
pending,
verified,
failure,
temporary_failure
secret
string

Secret key for the agency.

squarePhotoURL
string

URL to the agency's square photo.

supportEmail
string

Support email address for the agency.

themeColorUsage
enum<string>

Color usage for the theme.

Available options:
gradient,
colorful,
plain
themeVariant
enum<string>

Theme variant for the agency.

Available options:
default,
bordered,
flat,
faded
tosPage
string

Terms of service page URL.

VGsubDomain
string

(Edit only from dashboard) subdomain for the agency.

withVGBranding
boolean

Indicates if the agency has TIXAE Agents branding.

Response

200 - application/json
message
string
success
boolean