Skip to main content
POST
cURL

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Body

application/json

The identity and profile of a new RCS sender. provider and senderName are required; the profile fields are what recipients see and what the RCS platform reviews.

provider
string
required

The routing identifier your account was provisioned with for RCS. Contact support if you are unsure which value to use; an unknown value returns 400.

Example:

"YOUR_ROUTING_IDENTIFIER"

senderName
string
required

Unique technical name of the sender on the RCS platform. You pass it as from when you send RCS, and it cannot be changed later.

Example:

"example-brand"

displayName
string

The brand name recipients see at the top of the conversation.

Example:

"Example Brand"

description
string

Short description of your business or the sender's purpose, shown on the sender's info page.

Example:

"Order updates and support for Example Brand customers."

billingCategory
string

How the RCS platform bills conversations from this sender. Values accepted by the platform include CONVERSATIONAL and NON_CONVERSATIONAL.

Example:

"CONVERSATIONAL"

useCase
string

The kind of traffic the sender carries, reviewed by the RCS platform. Values accepted by the platform include OTP, TRANSACTIONAL, PROMOTIONAL and MULTI_USE.

Example:

"TRANSACTIONAL"

hostingRegion
string

The region where the RCS platform hosts the sender. Values accepted by the platform include NORTH_AMERICA, EUROPE and ASIA_PACIFIC. Cannot be changed later.

Example:

"NORTH_AMERICA"

brand
object

The brand the sender represents.

color
string

Accent colour for the sender's buttons and header, as a hex code such as #1A73E8.

Example:

"#1A73E8"

phones
object[]

Contact phone numbers shown on the sender's info page, each with a label.

emails
object[]

Contact email addresses shown on the sender's info page, each with a label.

websites
object[]

Websites shown on the sender's info page, each with a label.

bannerUrl
string<uri>

Publicly reachable HTTPS URL of the banner image shown at the top of the sender's info page.

Example:

"https://example.com/rcs/banner.jpg"

logoUrl
string<uri>

Publicly reachable HTTPS URL of the logo shown next to every message.

Example:

"https://example.com/rcs/logo.png"

privacy
object

Link to your privacy policy, shown on the sender's info page.

termsOfService
object

Link to your terms of service, shown on the sender's info page.

platform
object

Identifiers the RCS platform has already assigned to your agent, if you have any.

Response

The new sender in status pending.

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.

id
string<uuid>

Unique identifier of the sender on Vobiz (UUID). Use it in every /senders/{id} path.

Example:

"7a1c3e5f-9b2d-4c6e-8f0a-1b3d5e7f9a21"

accountId
string

Your Vobiz account ID (MA_...) that owns the sender.

Example:

"MA_XXXXXXXX"

provider
string

Internal routing identifier; do not rely on its value.

Example:

"YOUR_ROUTING_IDENTIFIER"

senderName
string

Unique technical name of the sender on the RCS platform. Pass it as from when you send RCS. Fixed after creation.

Example:

"example-brand"

displayName
string

The brand name recipients see at the top of the conversation.

Example:

"Example Brand"

description
string

Short description shown on the sender's info page.

Example:

"Order updates and support for Example Brand customers."

billingCategory
string

How the RCS platform bills conversations from this sender, for example CONVERSATIONAL or NON_CONVERSATIONAL.

Example:

"CONVERSATIONAL"

useCase
string

The kind of traffic the sender carries, for example OTP, TRANSACTIONAL, PROMOTIONAL or MULTI_USE.

Example:

"TRANSACTIONAL"

hostingRegion
string

The region where the RCS platform hosts the sender, for example NORTH_AMERICA, EUROPE or ASIA_PACIFIC. Fixed after creation.

Example:

"NORTH_AMERICA"

status
string
default:pending

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.

Example:

"pending"

brand
object

The brand the sender represents. Omitted when not set.

color
string

Accent colour as a hex code. Omitted when not set.

Example:

"#1A73E8"

phones
object[]

Contact phone numbers shown on the sender's info page. Omitted when none are set.

emails
object[]

Contact email addresses shown on the sender's info page. Omitted when none are set.

websites
object[]

Websites shown on the sender's info page. Omitted when none are set.

bannerUrl
string<uri>

HTTPS URL of the banner image. Omitted when not set.

Example:

"https://example.com/rcs/banner.jpg"

logoUrl
string<uri>

HTTPS URL of the logo image. Omitted when not set.

Example:

"https://example.com/rcs/logo.png"

privacy
object

Link to your privacy policy.

termsOfService
object

Link to your terms of service.

platform
object

Identifiers the RCS platform assigned to your agent. Omitted when not set.

createdAt
string<date-time>

When the sender was created on your account (ISO 8601, UTC).

Example:

"2026-10-12T10:30:00Z"

updatedAt
string<date-time>

When the sender last changed, including status refreshes (ISO 8601, UTC).

Example:

"2026-10-12T10:30:00Z"