Skip to main content
POST
/
v1
/
sms
/
number
/
update
Update SMS Configuration
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,
  "timeout_action": "<string>",
  "timeout_message": "<string>",
  "warning_time": 123,
  "warning_message": "<string>",
  "messaging_service_sid": "<string>",
  "objective": "<string>",
  "tools": [
    {}
  ],
  "temperature": 123,
  "pathway_id": "<string>",
  "pathway_version": "<string>",
  "start_node_id": "<string>",
  "restart_after_end_call": true,
  "timezone": "<string>",
  "summary_prompt": "<string>",
  "disposition_ids": [
    "<string>"
  ],
  "citation_schema_ids": [
    "<string>"
  ]
}
'
{
  "data": {
    "message": "SMS config updated for number +15550001111",
    "sms_config": {
      "webhook": null,
      "request_data": [],
      "time_out": null,
      "timeout_action": null,
      "timeout_message": null,
      "warning_time": null,
      "warning_message": null,
      "messaging_service_sid": null,
      "objective": "Chat with the user",
      "tools": [],
      "temperature": 0,
      "pathway_id": null,
      "pathway_version": null,
      "start_node_id": null,
      "restart_after_end_call": true,
      "timezone": null,
      "summary_prompt": null,
      "disposition_ids": null,
      "citation_schema_ids": null
    }
  },
  "errors": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.bland.ai/llms.txt

Use this file to discover all available pages before exploring further.

Enterprise Feature - SMS is only available on Enterprise plans. Contact your Bland representative for access.

​
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 user response, in seconds, before the timeout flow fires. Default is no timeout. Can be overridden per-conversation via /v1/sms/send or /v1/sms/create.
​
timeout_action
string
What to do when the timeout fires. Allowed values depend on your configuration (e.g. "send_sms" to send timeout_message).
​
timeout_message
string
Message sent when the timeout fires. Can be overridden per-conversation via /v1/sms/send or /v1/sms/create.
​
warning_time
number
Seconds to wait before sending the warning message. Must be less than time_out, otherwise the update is rejected. Can be overridden per-conversation via /v1/sms/send or /v1/sms/create.
​
warning_message
string
Message sent at warning_time. Can be overridden per-conversation via /v1/sms/send or /v1/sms/create.
​
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.
​
restart_after_end_call
boolean
When true, a new conversation is automatically started if the user texts after the current conversation has ended. When false, subsequent messages are stored in the ended conversation without triggering a new reply.
​
timezone
string
The timezone used for time-based variables in the conversation (e.g. "America/New_York").
​
summary_prompt
string
Custom prompt used to generate a conversation summary when the conversation ends. When set, an AI-generated summary is included in the status webhook and stored on the conversation.
​
disposition_ids
string[]
An array of outcome IDs to run when conversations end on this number. See Outcomes.
​
citation_schema_ids
string[]
An array of citation schema IDs to extract when conversations end on this number. See Citations.

​
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,
      "timeout_action": null,
      "timeout_message": null,
      "warning_time": null,
      "warning_message": null,
      "messaging_service_sid": null,
      "objective": "Chat with the user",
      "tools": [],
      "temperature": 0,
      "pathway_id": null,
      "pathway_version": null,
      "start_node_id": null,
      "restart_after_end_call": true,
      "timezone": null,
      "summary_prompt": null,
      "disposition_ids": null,
      "citation_schema_ids": null
    }
  },
  "errors": null
}
Docs for agents: llms.txt