Sign in
Setup Domain

Create

Create a new Setup Domain record.

post/api/cp/setup/domain

Request body

idinteger

Id

account_idinteger

Account Id (references account.id)

domainstring required

Domain (unique)

brand_namestring

Brand Name

managedinteger required

Managed

type'portal' | 'server' required

Type

landing_pagestring

Landing Page

accessstring

Access

featurestring

Feature

propstring[]

Prop

carrier_signupinteger

Carrier Signup

customer_signupinteger

Customer Signup

new_customer_defaultsstring

New Customer Defaults

new_customer_debit_limitnumber

New Customer Debit Limit

new_customer_statusstring

New Customer Status

ssl_certificatestring

Ssl Certificate

ssl_certificate_keystring

Ssl Certificate Key

ssl_ca_certificatestring

Ssl Ca Certificate

ssl_cert_request_hash_astring

Ssl Cert Request Hash A

ssl_cert_request_hash_bstring

Ssl Cert Request Hash B

astring

A

srvobject

Srv

ttlinteger

Ttl

template_customer_idinteger

Template Customer Id

javascriptstring

Javascript

cssstring

Css

currenciesstring

Currencies

cdr_fieldsstring

Cdr Fields

breakout_fieldsstring

Breakout Fields

logostring

Logo

footerstring

Footer

softphone_deploy_type'code' | 'sms' | 'existing'

Softphone Deploy Type

softphone_signup_fieldsstring

Softphone Signup Fields

softphone_menuobject

Softphone Menu

softphone_register_success_htmlstring

Softphone Register Success Html

softphone_hoststring

Softphone Host

softphone_flagsstring[]

Softphone Flags

smtp_serverstring

Smtp Server

smtp_usernamestring

Smtp Username

smtp_passwordstring password

Smtp Password

smtp_from_addressstring

Smtp From Address

flagsstring

Flags

Example request

{
  "id": 12345,
  "account_id": 1,
  "domain": "example_domain",
  "brand_name": "example_brand_name",
  "managed": 1,
  "type": "portal",
  "landing_page": "example_landing_page",
  "access": "example_access",
  "feature": "example_feature",
  "prop": "value",
  "carrier_signup": 1,
  "customer_signup": 1,
  "new_customer_defaults": "example_new_customer_defaults",
  "new_customer_debit_limit": 99.99,
  "new_customer_status": "example_new_customer_status",
  "ssl_certificate": "Sample ssl_certificate text content",
  "ssl_certificate_key": "Sample ssl_certificate_key text content",
  "ssl_ca_certificate": "Sample ssl_ca_certificate text content",
  "ssl_cert_request_hash_a": "example_ssl_cert_request_hash_a",
  "ssl_cert_request_hash_b": "example_ssl_cert_request_hash_b",
  "a": "example_a",
  "srv": "example_srv",
  "ttl": 123,
  "template_customer_id": 1,
  "javascript": "Sample javascript text content",
  "css": "Sample css text content",
  "currencies": "example_currencies",
  "cdr_fields": "example_cdr_fields",
  "breakout_fields": "example_breakout_fields",
  "logo": "example_logo",
  "footer": "example_footer",
  "softphone_deploy_type": "code",
  "softphone_signup_fields": "example_softphone_signup_fields",
  "softphone_menu": "Sample softphone_menu text content",
  "softphone_register_success_html": "example_softphone_register_success_html",
  "softphone_host": "example_softphone_host",
  "softphone_flags": "BALANCE",
  "smtp_server": "example_smtp_server",
  "smtp_username": "example_smtp_username",
  "smtp_password": "example_smtp_password",
  "smtp_from_address": "example_smtp_from_address",
  "flags": "example_flags"
}

Response

Successful response

statusstring

Operation status

Example response

{
  "id": 12345,
  "status": "OK"
}

Changes