Update campaign disposition

PUT 
/:organization_id/campaign_dispositions/:id

Updates a specific campaign disposition

Request

Path Parameters

id integerrequired

Campaign disposition ID

application/json

Bodyrequired

organization_idinteger

ID of the organization this disposition belongs to

namestringrequired

Name of the disposition

descriptionstring

Description of the disposition

record_statusstring

Status to assign to dialer records with this disposition

close_numberboolean

Whether this disposition should close the phone number for further dialing

do_not_callboolean

Whether this disposition marks the contact as do not call

do_not_call_scopestring

Scope of the do not call flag (e.g., organization, campaign)

Responses

200

Campaign disposition updated successfully

application/json

Schema

Schema

idinteger
Unique identifier for the campaign disposition
organization_idinteger
ID of the organization this disposition belongs to
namestring
Name of the disposition
descriptionstring
Description of the disposition
record_statusstring
Status to assign to dialer records with this disposition
close_numberboolean
Whether this disposition should close the phone number for further dialing
do_not_callboolean
Whether this disposition marks the contact as do not call
do_not_call_scopestring
Scope of the do not call flag (e.g., organization, campaign)
created_atdate-time
updated_atdate-time

Example (auto)

{
  "id": 0,
  "organization_id": 0,
  "name": "string",
  "description": "string",
  "record_status": "string",
  "close_number": true,
  "do_not_call": true,
  "do_not_call_scope": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

401

Unauthorized

403

Forbidden

404

Not found

422

Unprocessable entity

application/json

Schema

Schema

errorobject

Example (auto)

{
  "error": {}
}

Authorization: http

name: basicAuthtype: httpscheme: basicdescription: Basic authentication using API key ID and API key

• python
• nodejs
• ruby
• curl
• go
• php
• java
• powershell
• javascript
• rust

• HTTP.CLIENT
• REQUESTS

import http.client
import json

conn = http.client.HTTPSConnection("cloud-staging.cloverhound.com")
payload = ''
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
}
conn.request("PUT", "/:organization_id/campaign_dispositions/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Auth

Username

Password

Parameters

id — pathrequired

Body required

{
  "organization_id": 0,
  "name": "string",
  "description": "string",
  "record_status": "string",
  "close_number": true,
  "do_not_call": true,
  "do_not_call_scope": "string"
}