Skip to main content
PATCH
/
v1
/
phone-numbers
/
{phoneNumber}
Update Phone Number
curl --request PATCH \
  --url https://api.sigmamind.ai/v1/phone-numbers/{phoneNumber} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "friendlyName": "Support Line - US",
  "inboundAgentId": "awTw7UKhOsLGiDbt",
  "outboundAgentId": "awTw7UKhOsLGiDbt",
  "terminationSipUri": "sip.telnyx.com",
  "trunkUsername": "my_trunk_user",
  "trunkPassword": "tr!nkP@ssword",
  "outboundPhoneNumber": "+14155552671"
}
'
{
  "sipPhoneNumber": "+14155552671",
  "provider": "twilio",
  "inboundAgentId": "agent_D5D0p7TUs66TTAEAx",
  "outboundAgentId": "agent_D5D0p7TUs66TTAEAx",
  "outboundPhoneNumber": "+14155552671",
  "active": true,
  "terminationSipURI": "sip.telnyx.com",
  "friendlyName": "Support Line - US"
}

Authorizations

​
X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Path Parameters

​
phoneNumber
string
required

Phone number to update, in +E.164 format. Obtained from the sipPhoneNumber field in the Create, Import, or List Phone Numbers response.

Body

application/json

Request body to partially update a phone number record. Only fields included in the request are updated — omitted fields remain unchanged. Applies to both SigmaMind-provisioned numbers and BYO numbers imported via SIP trunking.

​
friendlyName
string

Updated human-readable label for this phone number. Used to identify it in listings and dashboards. Omit to leave the existing label unchanged.

Maximum string length: 128
Example:

"Support Line - US"

​
inboundAgentId
string

Updated agent ID for handling inbound calls received on this number. Replaces the currently assigned inbound agent. All inbound calls arriving after this update will be routed to the new agent. Pass null to remove the inbound agent assignment. Omit to leave the existing assignment unchanged.

Maximum string length: 64
Example:

"awTw7UKhOsLGiDbt"

​
outboundAgentId
string

Updated agent ID for handling outbound calls made from this number. Replaces the currently assigned outbound agent. All outbound calls placed after this update will use the new agent. Pass null to remove the outbound agent assignment. Omit to leave the existing assignment unchanged.

Maximum string length: 64
Example:

"awTw7UKhOsLGiDbt"

​
terminationSipUri
string

Updated SIP URI of the termination endpoint used to route outbound calls through the SIP trunk. Applicable only for BYO numbers imported via SIP trunking — has no effect on SigmaMind-provisioned numbers. Obtain this value from your telecom provider's SIP trunking configuration. Omit to leave the existing SIP URI unchanged.

Maximum string length: 253
Example:

"sip.telnyx.com"

​
trunkUsername
string

Updated username for authenticating outbound calls on the SIP trunk. Applicable only for BYO numbers — must match the trunk username in your provider's account. Omit to leave the existing username unchanged.

Maximum string length: 128
Example:

"my_trunk_user"

​
trunkPassword
string

Updated password for authenticating outbound calls on the SIP trunk. Applicable only for BYO numbers — must match the trunk password in your provider's account. Stored securely and never returned in API responses. Omit to leave the existing password unchanged.

Maximum string length: 128
Example:

"tr!nkP@ssword"

​
outboundPhoneNumber
string

Updated default destination number for test calls placed from this number, in +E.164 format. Used to verify the number and trunk configuration are working correctly. Must be a valid number capable of receiving calls. Omit to leave the existing test number unchanged.

Pattern: ^\+[1-9][0-9]{6,14}$
Example:

"+14155552671"

Response

OK

Caller phone number used to dial contacts in this campaign. This number appears as the caller ID on recipients' devices.

​
sipPhoneNumber
string

The caller’s phone number in +E.164 format. This number must be obtained from SigmaMind or configured using SIP trunking with SigmaMind.

Example:

"+14155552671"

​
provider
enum<string>

The service provider associated with the phone number.

Available options:
twilio,
telnyx,
byo
Example:

"twilio"

​
inboundAgentId
string

Default agent ID assigned to handle inbound calls for this phone number.

Example:

"agent_D5D0p7TUs66TTAEAx"

​
outboundAgentId
string

Default agent ID assigned to handle outbound calls for this phone number.

Example:

"agent_D5D0p7TUs66TTAEAx"

​
outboundPhoneNumber
string

The default outbound phone number of the callee, represented in +E.164 format

Example:

"+14155552671"

​
active
boolean

Indicates whether the phone number is currently active and available for use.

Example:

true

​
terminationSipURI
string

The SIP URI of the phone number, provided by the service provider for call termination.

Example:

"sip.telnyx.com"

​
friendlyName
string

A user-friendly display name assigned to this phone number.

Example:

"Support Line - US"