RCSv4

Cancel an RCS change request

POST/rcs/changes/{changeId}/cancel

Withdraw a change request that's still requested, and refund its fees. Canceling again is safe. A sender removal can't be canceled. OAuth apps need numbers:manage.

Path parameters

changeIdRequiredstring

The change request's change_id.

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Returns

dataoptionalRcsChange

A paid change to a submitted sender or brand, or a removed sender's deletion, which Blooio carries to Google and the carriers.

change_idRequiredstring

rcschg_....

kindRequiredstring

sender_profile changes a sender's display_name, logo_url, or banner_url; brand_contact changes the brand's point of contact; sender_removal deletes a removed sender at Google.

"sender_profile""brand_contact""sender_removal"
channel_idRequiredstring | null

The sender, or null for a brand_contact change.

statusRequiredstring

requested until Blooio passes it on, then sent. applied once the sender or brand shows the change; rejected with the reason in note. Only a requested change can be canceled.

"requested""sent""applied""rejected""canceled"
changesRequiredobject

The fields requested, with their new values.

previousRequiredobject

What those fields held when it was requested.

reviewsRequiredinteger

The reviews charged for it: one per profile field changed, one for a brand contact, none for a sender_removal. Refunded if the change is canceled, or rejected before it was sent.

noteRequiredstring | null

Why it was rejected.

sent_atRequiredinteger | null

Epoch ms.

created_atRequiredinteger

Epoch ms.

updated_atRequiredinteger

Epoch ms.

Response codes

200The canceled change request
400`invalid_change_id`.
401Your API key is missing or invalid. Pass it as a bearer token.
404`rcs_change_not_found`.
409`rcs_change_state_conflict` (carries `change_status`): it was already sent, settled, or is a sender removal.

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request
curl -X POST https://api.blooio.com/v4/rcs/changes/obj_a1b2c3d4/cancel \
Response objectexample
{  "data": {    "change_id": "obj_a1b2c3d4",    "kind": "sender_profile",    "channel_id": "ch_a1b2c3d4",    "status": "requested",    "changes": {},    "previous": {},    "reviews": 0,    "note": "Example description",    "sent_at": 0,    "created_at": 0,    "updated_at": 0  }}