Site Home
API Reference
LoginTry for Free

Create Custom Domain

post
https://{application_vanity_domain}/api/v1/custom-domains
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a new custom domain resource. Only two custom domains can be created per owner, and each must be globally unique.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

PermissionBoundaryDescription
custom-domain:createApplicationThe subject can create custom domains under the application to which the subject is associated.
TenantThe subject can create custom domains associated with the tenant to which the subject belongs.
Tenant Inclusion ListThe subject can create custom domains associated with tenants specified in the tenant inclusion list.
Tenant Exclusion ListThe subject can create custom domains associated with tenants in the subject's application that are not on the tenant exclusion list.
Body Params

Custom domain resource

Custom Domain

string
enum
length between 1 and 30

[Required on Create] The type of the owner of the resource.

Allowed:
string
length between 1 and 26

[Required on Create] The ID of the owner of the resource.

string
length between 1 and 100

[Required on Create] The custom domain name. This value must be a subdomain of a valid public suffix and can't end with wristband.dev. The domain name must be globally unique (case-insensitive).

Responses

Updated 22 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago