Sign in
Did

Update

Update an existing Did record by ID.

put/api/cp/did/{id}

Path parameters

idinteger required

Id identifier

Request body

idinteger

Id

account_idinteger

Account Id (references account.id)

customer_idinteger

Customer Id (references company.id)

provider_idinteger

Provider Id (references company.id)

didstring

Did

provider_card_idstring

Provider Card Id

customer_card_idstring

Customer Card Id

destinationstring required

Destination

destination_typestring

Destination Type

destination2string

Destination 2

destination2_typestring

Destination 2 Type

destination3string

Destination 3

destination3_typestring

Destination 3 Type

notesstring

Notes

channelsinteger

Channels

cpsinteger

Cps

max_durationinteger

Max Duration

rtp_proxyinteger required

Rtp Proxy

rtp_mode'Relaxed' | 'Strict'

Rtp Mode

timeoutstring[]

Timeout

costnumber

Cost

retailnumber

Retail

start_datestring date-time

Start Date

tagsstring

Tags

p_asserted_identity'default' | 'remove'

P Asserted Identity

package_idinteger

Package Id

recordinginteger required

Recording

transcodinginteger

Transcoding

created_datestring date-time

Created Date

assigned_datestring date-time

Assigned Date

enabledinteger required

Enabled

sandbox_idinteger

Sandbox Id

scriptforge_timeoutnumber

Scriptforge Timeout

scriptforge_timeout_actionstring

Scriptforge Timeout Action

varsstring

Vars

retain_display_nameinteger

Retain Display Name

min_daysinteger

Min Days

ftc_reportedinteger required

Ftc Reported

rtp_codecobject

Rtp Codec

stir_shaken_min_attest'A' | 'B' | 'C'

Stir Shaken Min Attest

spam_scoreinteger

Spam Score

ipqsinteger

Ipqs

flagsstring required

Flags

last_calledstring date-time nullable

Last Called

block_source_typestring

Block Source Type

spam_scoutinteger

Spam Scout

Example request

{
  "id": 12345,
  "account_id": 1,
  "customer_id": 1,
  "provider_id": 1,
  "did": "example_did",
  "provider_card_id": 1,
  "customer_card_id": 1,
  "destination": "example_destination",
  "destination_type": "example_destination_type",
  "destination2": "example_destination2",
  "destination2_type": "example_destination2_type",
  "destination3": "example_destination3",
  "destination3_type": "example_destination3_type",
  "notes": "Sample notes text content",
  "channels": 123,
  "cps": 123,
  "max_duration": 123,
  "rtp_proxy": 1,
  "rtp_mode": "Relaxed",
  "timeout": "SIP Ping",
  "cost": 99.99,
  "retail": 99.99,
  "start_date": "2025-01-17T10:30:00Z",
  "tags": "example_tags",
  "p_asserted_identity": "default",
  "package_id": 1,
  "recording": 1,
  "transcoding": 1,
  "created_date": "2025-01-17T10:30:00Z",
  "assigned_date": "2025-01-17T10:30:00Z",
  "enabled": true,
  "sandbox_id": 1,
  "scriptforge_timeout": 99.99,
  "scriptforge_timeout_action": "example_scriptforge_timeout_action",
  "vars": "Sample vars text content",
  "retain_display_name": 1,
  "min_days": 123,
  "ftc_reported": 1,
  "rtp_codec": "example_rtp_codec",
  "stir_shaken_min_attest": "A",
  "spam_score": 1,
  "ipqs": 1,
  "flags": "example_flags",
  "last_called": "2025-01-17T10:30:00Z",
  "block_source_type": "example_block_source_type",
  "spam_scout": 1
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.