Create phone menu

POST

/api/v1/phone-menus

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/phone-menus \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "greeting_text": "example", "greeting_type": "text", "options": [ { "digit": "example", "label": "example", "action": "route_to_user", "target_id": "example" } ], "timeout_seconds": 1, "max_retries": 1, "fallback_action": "voicemail", "fallback_target_id": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 200 characters

greeting_text

string

<= 2000 characters

greeting_type

string

Allowed values: text audio

options

required

Array<object>

>= 1 items <= 12 items

object

digit

required

string

/^[0-9*#]$/

label

required

string

>= 1 characters <= 200 characters

action

required

string

Allowed values: route_to_user route_to_group route_to_menu route_to_external voicemail

target_id

Any of:

string

string

>= 1 characters <= 200 characters

null

null

timeout_seconds

integer

>= 1 <= 60

max_retries

integer

>= 1 <= 10

fallback_action

string

Allowed values: voicemail route_to_user hangup

fallback_target_id

Any of:

string

string

/^[0-9a-fA-F]{24}$/

null

null

Responses

201

Created

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}