API Reference

Create a New Organization

post
https://api.web1on1.chat/v2/organizations

You may create a organization using this action.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the Organization.

string

Representative name of the Organization, to be used in external communications like chat widgets. Defaults to Organization name.

string
enum
Defaults to active

Organization status.

Allowed:
string

An email address for users to contact support in case of any issues with the organization.

string

The URL of the Organization's corporate website.

string

The URL of the Organization's logo image.

string

The two-letter ISO 3166 country code of the Organization's headquarters.

string
enum
Defaults to en

ISO 639-1 two-letter language code.

Allowed:
string

Timezone of the Organizational HQ, as specified in the IANA time zone (Olson) database. Default: Europe/Amsterdam.

string

The industry the Organization is in.

settings
object

Configuration settings for the organization.

aliases
array

User avatars and aliases to use instead of real names.

aliases
stopwords
array

List of words that should not be used in any communication on behalf of the Organization.

stopwords
commands
array

List of custom (bot) commands that should be made available to the agent.

commands
tags
array

List of keywords/tags for the organization.

tags
string

The white label subdomain part for the organization.

string

The white label domain for the organization.

partners
array

Partner organizations to allow access to conversations.

partners
whitelist
array

List of emails and domains for which agent self-registration is allowed.

whitelist
string
enum
Defaults to guest

Self-registering agent role.

Allowed:
dataRetention
object

An object specifying record expiration and purge time.

billingInfo
object
required

An object specifying the organization billing settings.

string

An email 'from' sender address for results notifications.

meta
object

Free-form object of key-values, that will be passed on to external systems, eg in webhook data.

Response

Updated about 1 year ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?