Update an RCS sender
Updates the sender’s profile on the RCS platform and then on your account, and returns the updated sender. Send only the fields you want to change; fields you leave out keep their value.
curl --request PUT \
--url https://api.vobiz.ai/api/v1/sms/senders/{id} \
--header 'Content-Type: application/json' \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"displayName": "Example Brand Support",
"description": "Order updates, returns and support for Example Brand customers.",
"websites": [
{
"url": "https://example.com/help",
"label": "Help centre"
}
]
}
'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
from vobiz.sms import SenderWebsite
client.sms.rcs_senders.update_sender(
id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
display_name="Example Brand Support",
description="Order updates, returns and support for Example Brand customers.",
websites=[
SenderWebsite(
url="https://example.com/help",
label="Help centre",
)
],
)
const options = {
method: 'PUT',
headers: {
'X-Auth-ID': '<api-key>',
'X-Auth-Token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
displayName: 'Example Brand Support',
description: 'Order updates, returns and support for Example Brand customers.',
websites: [{url: 'https://example.com/help', label: 'Help centre'}]
})
};
fetch('https://api.vobiz.ai/api/v1/sms/senders/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Path Parameters
The sender's id (UUID), as returned by POST /senders or GET /senders. An unknown id returns sender not found.
Body
Any subset of the editable RCS sender fields. Fields you leave out keep their value; provider, senderName and hostingRegion are fixed after creation.
The brand name recipients see at the top of the conversation.
"Example Brand"
Short description of your business or the sender's purpose, shown on the sender's info page.
"Order updates and support for Example Brand customers."
How the RCS platform bills conversations from this sender, for example CONVERSATIONAL or NON_CONVERSATIONAL.
"CONVERSATIONAL"
The kind of traffic the sender carries, for example OTP, TRANSACTIONAL, PROMOTIONAL or MULTI_USE.
"TRANSACTIONAL"
The brand the sender represents.
Show child attributes
Show child attributes
Accent colour for the sender's buttons and header, as a hex code such as #1A73E8.
"#1A73E8"
Contact phone numbers shown on the sender's info page.
Show child attributes
Show child attributes
Contact email addresses shown on the sender's info page.
Show child attributes
Show child attributes
Websites shown on the sender's info page.
Show child attributes
Show child attributes
Publicly reachable HTTPS URL of the banner image.
"https://example.com/rcs/banner.jpg"
Publicly reachable HTTPS URL of the logo image.
"https://example.com/rcs/logo.png"
Link to your privacy policy.
Show child attributes
Show child attributes
Link to your terms of service.
Show child attributes
Show child attributes
Identifiers the RCS platform has assigned to your agent.
Show child attributes
Show child attributes
Response
The updated sender.
An RCS sender (agent): the verified brand identity that recipients see instead of a phone number. Send RCS from it by passing its senderName as from with channel: rcs.
Unique identifier of the sender on Vobiz (UUID). Use it in every /senders/{id} path.
"7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21"
Your Vobiz account ID (MA_...) that owns the sender.
"MA_XXXXXXXX"
Internal routing identifier; do not rely on its value.
"YOUR_ROUTING_IDENTIFIER"
Unique technical name of the sender on the RCS platform. Pass it as from when you send RCS. Fixed after creation.
"example-brand"
The brand name recipients see at the top of the conversation.
"Example Brand"
Short description shown on the sender's info page.
"Order updates and support for Example Brand customers."
How the RCS platform bills conversations from this sender, for example CONVERSATIONAL or NON_CONVERSATIONAL.
"CONVERSATIONAL"
The kind of traffic the sender carries, for example OTP, TRANSACTIONAL, PROMOTIONAL or MULTI_USE.
"TRANSACTIONAL"
The region where the RCS platform hosts the sender, for example NORTH_AMERICA, EUROPE or ASIA_PACIFIC. Fixed after creation.
"NORTH_AMERICA"
Launch status reported by the RCS platform, stored on your account. pending until the platform reports otherwise. Call GET /senders/{id}/status to refresh it.
"pending"
The brand the sender represents. Omitted when not set.
Show child attributes
Show child attributes
Accent colour as a hex code. Omitted when not set.
"#1A73E8"
Contact phone numbers shown on the sender's info page. Omitted when none are set.
Show child attributes
Show child attributes
Contact email addresses shown on the sender's info page. Omitted when none are set.
Show child attributes
Show child attributes
Websites shown on the sender's info page. Omitted when none are set.
Show child attributes
Show child attributes
HTTPS URL of the banner image. Omitted when not set.
"https://example.com/rcs/banner.jpg"
HTTPS URL of the logo image. Omitted when not set.
"https://example.com/rcs/logo.png"
Link to your privacy policy.
Show child attributes
Show child attributes
Link to your terms of service.
Show child attributes
Show child attributes
Identifiers the RCS platform assigned to your agent. Omitted when not set.
Show child attributes
Show child attributes
When the sender was created on your account (ISO 8601, UTC).
"2026-10-12T10:30:00Z"
When the sender last changed, including status refreshes (ISO 8601, UTC).
"2026-10-12T10:30:00Z"
Was this page helpful?
curl --request PUT \
--url https://api.vobiz.ai/api/v1/sms/senders/{id} \
--header 'Content-Type: application/json' \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"displayName": "Example Brand Support",
"description": "Order updates, returns and support for Example Brand customers.",
"websites": [
{
"url": "https://example.com/help",
"label": "Help centre"
}
]
}
'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
from vobiz.sms import SenderWebsite
client.sms.rcs_senders.update_sender(
id="5d7f9b1c-3e5a-4c7e-9f1b-3d5f7a9c1e3b",
display_name="Example Brand Support",
description="Order updates, returns and support for Example Brand customers.",
websites=[
SenderWebsite(
url="https://example.com/help",
label="Help centre",
)
],
)
const options = {
method: 'PUT',
headers: {
'X-Auth-ID': '<api-key>',
'X-Auth-Token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
displayName: 'Example Brand Support',
description: 'Order updates, returns and support for Example Brand customers.',
websites: [{url: 'https://example.com/help', label: 'Help centre'}]
})
};
fetch('https://api.vobiz.ai/api/v1/sms/senders/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));