Settings

Update Transfer Destination

Changed on

Update an existing transfer destination. Developer only.

put/settings/transfer-destinations/{transfer_destination_id}

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/settings/transfer-destinations/{transfer_destination_id}
  • Auth: none declared

Path parameters

transfer_destination_idstring uuid required

Request body

namestring nullable

Name of the transfer destination

phone_numberstring nullable

Phone number in E.164 format (e.g., +12025551234)

test_phone_numberstring nullable

Alternate number in E.164 format used for test calls when test transfer numbers are enabled

sip_uristring nullable

Optional SIP URI (e.g. sip:4601@brianjlevy.24735.service). When set, the transfer is handed to Vapi as a SIP destination over the customer's BYO SIP trunk instead of dialed over the PSTN. phone_number is still required and is what gets recorded on the call.

spanish_transfer_destination_idstring uuid nullable

Optional destination to use instead of this one when the caller is a Spanish speaker (e.g. point a department with no Spanish speakers at Reception). Applied at most once, never chained, and must belong to the same customer and not be this destination itself.

descriptionstring nullable

Optional description of when to use this destination

name_is_internalboolean nullable

Whether this destination's name is internal-only and must never be spoken to callers

Response

Successful Response

transfer_destination_idstring uuid required
namestring required

Name of the transfer destination

phone_numberstring required

Phone number in E.164 format

test_phone_numberstring nullable

Alternate number used for test calls when test transfer numbers are enabled

sip_uristring nullable

Optional SIP URI (e.g. sip:4601@brianjlevy.24735.service). When set, the transfer is handed to Vapi as a SIP destination over the customer's BYO SIP trunk instead of dialed over the PSTN. phone_number is still required and is what gets recorded on the call.

spanish_transfer_destination_idstring uuid nullable

Optional destination to use instead of this one when the caller is a Spanish speaker (e.g. point a department with no Spanish speakers at Reception). Applied at most once, never chained, and must belong to the same customer and not be this destination itself.

descriptionstring nullable

Optional description of when to use this destination

name_is_internalboolean

Whether this destination's name is internal-only and must never be spoken to callers

Changes

  • 83f801d03bcfRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 32f6d8075c56Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status