POST
/
v2
/
agencies

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string
required

The name of the agency.

squarePhotoURL
string

URL to the agency's square photo.

darkModeSquarePhotourl
string

URL to the agency's dark mode square photo.

brandingText
string

Text for agency branding (supports markdown).

customDomain
string

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

VGsubDomain
string

(Edit only from dashboard) subdomain for the agency.

customThemeJSONString
object

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

Custom theme object for the agent

isVerifiedSubDomain
boolean

Indicates if the subdomain is verified.

isVerifiedCustomDomain
boolean

Indicates if the custom domain is verified.

withVGBranding
boolean

Indicates if the agency has TIXAE Agents branding.

themeVariant
enum<string>

Theme variant for the agency.

Available options:
default,
bordered,
flat,
faded
themeColorUsage
enum<string>

Color usage for the theme.

Available options:
gradient,
colorful,
plain
googleFont
string

Google font used by the agency Browse fonts

mainWebsite
string

Main website URL for the agency.

supportEmail
string

Support email address for the agency.

tosPage
string

Terms of service page URL.

privacyPolicypPage
string

Privacy policy page URL.

secret
string

Secret key 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
address
string

Address of the agency.

customCSS
string

Custom CSS for the agency to inject on the dashboard.

enableHumanHandoff
boolean

Indicates if human handoff is enabled.

resendEmailDomain
string

Domain for resend email.

resendEmailDomainId
string

Identifier for the resend email domain.

resendEmailDomainStatus
enum<string>

Status of the resend email domain.

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

JSON string representing resend email domain records.

Response

200 - application/json
success
boolean
message
string