Skip to main content
POST
/
v1
/
voice
/
agents
/
lead-submitter
/
settings
cURL
curl --request POST \
  --url https://api.comm.com/api/v1/voice/agents/lead-submitter/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "url": "<string>",
  "method": "POST",
  "transcript_as_text": true,
  "call_outcomes": [
    "interested"
  ],
  "field_aliases": [
    "<string>"
  ],
  "tags_on_complete": [
    "<string>"
  ],
  "headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "additional_data": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "data": {
    "url": "<string>",
    "enabled": false,
    "method": "POST",
    "headers": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "call_outcomes": [
      "<string>"
    ],
    "tags_on_complete": [
      "<string>"
    ],
    "transcript_as_text": false,
    "field_aliases": [
      "<string>"
    ],
    "additional_data": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
enabled
boolean
required
url
string
required
Maximum string length: 255
method
enum<string>
required
Available options:
POST,
PUT,
PATCH
transcript_as_text
boolean
required
call_outcomes
enum<string>[]
required
Available options:
interested,
not_interested,
voice_mail,
call_me_later,
do_not_call,
wrong_number,
no_user_response,
not_qualified,
burned_experience,
quick_hangup,
maybe_interested,
agent_issue,
no_answer,
failed,
audio_issue,
busy,
unknown_error
field_aliases
string[] | null
tags_on_complete
string[] | null
Maximum array length: 10
Maximum string length: 50
headers
object[] | null
Maximum array length: 10
additional_data
object[] | null
Maximum array length: 10

Response

LeadSubmitterData

data
LeadSubmitterData · object
required