Update Sip Trunk

Update an existing SIP trunk's settings. This API allows you to perform partial updates to trunk settings. Only the fields that are provided will be updated; omitted fields will retain their existing values.

Common Use Cases

  • Suspend/Enable a SIP trunk by setting enabled=false/true
  • Change the trunk's password for enhanced security
  • Update caller ID settings for outbound calls
  • Configure SMS capabilities
  • Modify CrazyPhone softphone settings

Important Notes

  • The following fields cannot be modified:
    • id
    • username
  • Caller ID numbers must be verified before they can be used
    • Get verified numbers via GET /api/v1/account/verified-cli/
  • SMS sender numbers must be verified and start with '614'
  • Required password format:
    • Must be at least 8 characters long
    • Must contain at least 1 uppercase letter
    • Must contain at least 1 lowercase letter
    • Must contain at least 1 number

Parameters

  • trunk_id: UUID of the SIP trunk to update (format: 00000000-0000-0000-0000-000000000000)

Request Body Fields (all optional)

  • enabled: Control trunk status
    • Set to false to suspend the trunk
    • Set to true to enable the trunk
  • password: Update trunk authentication
    • Minimum 8 characters
    • Must include: 1 uppercase, 1 lowercase, 1 number
    • Example: "SecurePass123"
  • area_code: Set geographic routing
    • Example: "02" for Sydney
  • caller_id_number: Set outbound caller ID
    • Must be pre-verified
    • Example: "61291234567"
  • description: Add a friendly name/note
    • Example: "Sales Team Trunk"
  • hide_caller_id: Control number privacy
    • Set to true to hide outbound caller ID
    • Set to false to show outbound caller ID
  • sms_sender: Configure SMS capabilities
    • Must start with '614' and be pre-verified
    • Example: "61412345678"
  • softphone_show_balance: CrazyPhone settings
    • Set to true to display balance
    • Set to false to hide balance
  • softphone_sync_sms: CrazyPhone SMS features
    • Set to true to enable SMS sync
    • Set to false to disable SMS sync

Returns

Updated SIP trunk object with all current settings

Raises

  • 400 - If caller ID or SMS sender is not verified or SMS sender format is invalid
  • 401 - If user is not authenticated
  • 404 - If SIP trunk is not found
  • 422 - If password format does not meet requirements
  • 500 - If there is an error communicating with the Crazytel API
Path Params
string
required
Body Params
Responses

400

Invalid caller ID or SMS sender

401

Unauthorized

404

SIP trunk not found

422

Invalid password format

500

Internal Server Error

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json