Sign in
Setup Webphone

Create

Create a new Setup Webphone record.

post/api/cp/setup/webphone

Request body

idinteger

Id

account_idinteger

Account Id

brand_namestring

Brand Name

domainstring

Domain

deploy_type'code' | 'sms' | 'existing'

Deploy Type

signup_fieldsstring

Signup Fields

menuobject

Menu

register_success_htmlstring

Register Success Html

hoststring

Host

flagsstring[]

Flags

netlify_site_idstring

Netlify Site Id

template_customer_idinteger

Template Customer Id

customersstring

Customers

cssstring

Css

codec_deletestring required

Codec Delete

codec_prioritystring required

Codec Priority

Example request

{
  "id": 12345,
  "account_id": 1,
  "brand_name": "example_brand_name",
  "domain": "example_domain",
  "deploy_type": "code",
  "signup_fields": "example_signup_fields",
  "menu": "Sample menu text content",
  "register_success_html": "Sample register_success_html text content",
  "host": "example_host",
  "flags": "BALANCE",
  "netlify_site_id": 1,
  "template_customer_id": 1,
  "customers": "example_customers",
  "css": "Sample css text content",
  "codec_delete": "example_codec_delete",
  "codec_priority": "example_codec_priority"
}

Response

Successful response

statusstring

Operation status

Example response

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

Changes