Sign in
latestOpenAPI 3.0.32026-08-15138306314.9 KB

cfd9e65e79bb

accounts

Create a new account

Creates a new account with the specified name and optional metadata.

Rate limit: 60 requests per minute

post/accounts

Request body

account_type'customer' | 'internal' | 'community' | 'partner'

The type of the account. Must be one of "customer", "internal", "community", or "partner". Defaults to "customer" if not specified.

domainstring

Deprecated. Please use Domains and PrimaryDomain instead.

domainsstring[]

The domains of the account, without any leading scheme, for example stripe.com. Must specify one domain as primary.

logo_urlstring

The logo URL of the account. Must be a square .png, .jpg or .jpeg.

namestring required

The name of the account.

owner_idstring

The ID of the owner of the account.

primary_domainstring

Must be in the list of domains. If there are any domains, there must be exactly one primary domain.

subaccount_idsstring[]

An array of account IDs to be added as subaccounts to this account. For normal accounts, these represent subaccounts. For partner accounts, these represent associated accounts.

tagsstring[]

An array of strings to use as tags on this account. If provided, the accounts tags will be updated to the given tags.

Example request

{
  "account_type": "customer",
  "channels": [
    {
      "mirror_to": {
        "source": "slack"
      },
      "source": "slack"
    }
  ]
}

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": {
    "channels": [
      {
        "mirror_to": {
          "source": "slack"
        },
        "source": "slack"
      }
    ],
    "type": "customer"
  }
}