POST
/
v1
/
sms
/
number
/
update
curl --request POST \
  --url https://api.bland.ai/v1/sms/number/update \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "phone_number": "<string>",
  "webhook": "<string>",
  "request_data": [
    {}
  ],
  "time_out": 123,
  "messaging_service_sid": "<string>",
  "objective": "<string>",
  "tools": [
    {}
  ],
  "temperature": 123,
  "pathway_id": "<string>",
  "pathway_version": "<string>",
  "start_node_id": "<string>"
}'
{
  "data": {
    "message": "SMS config updated for number +15550001111",
    "sms_config": {
      "webhook": null,
      "request_data": [],
      "time_out": null,
      "messaging_service_sid": null,
      "objective": "Chat with the user",
      "tools": [],
      "temperature": 0,
      "pathway_id": null,
      "pathway_version": null,
      "start_node_id": null
    }
  },
  "errors": null
}

​
Headers

​
authorization
string
required

Your API key for authentication.

​
Body Parameters

​
phone_number
string
required

The E.164 formatted phone number to update (must belong to the authenticated user).

​
webhook
string

When the agent sends a response, we’ll send the message details in a POST request to the URL you specify here, along with chat history.

​
request_data
object|array

Request data fields are available to the AI agent during the call when referenced in the associated pathway or task.

​
time_out
number

Maximum time to wait for a response. Default is no timeout.

​
messaging_service_sid
string

Twilio Messaging Service SID, if set.

​
objective
string

Assistant system prompt or conversational goal.

​
tools
array

List of tools available to the assistant.

​
temperature
number

The model’s temperature setting, controlling creativity.

​
pathway_id
string

The ID of the linked conversational pathway (if any).

​
pathway_version
string

The specific version of the pathway to use.

​
start_node_id
string

Entry point node ID for the pathway.

​
Response

​
data
object

Contains a confirmation message and the updated SMS configuration.

​
data.message
string

Success message confirming the update.

​
data.sms_config
object

The updated and sanitized SMS configuration object.

​
errors
null|array

null on success. If an error occurs, this will be an array of error objects.

​
errors[].message
string

A human-readable description of the error.

​
errors[].error
string

A machine-readable error code.

{
  "data": {
    "message": "SMS config updated for number +15550001111",
    "sms_config": {
      "webhook": null,
      "request_data": [],
      "time_out": null,
      "messaging_service_sid": null,
      "objective": "Chat with the user",
      "tools": [],
      "temperature": 0,
      "pathway_id": null,
      "pathway_version": null,
      "start_node_id": null
    }
  },
  "errors": null
}