Update an RCS Agent

put

https://api.liguelead.com.br/v1/rcs/agents/{id}

Replaces the registration's brand.

This is a replacement, not a merge. A field left out of the payload is emptied - that is what PUT means, and it is the only way to clear a field.

The app binding is not part of the payload: it was decided when the registration was created, and moving an agent between apps would be creating another one. Sending app_ids answers 422.

Editing a registration that is already submitted or under_review answers 409 - it is out of your hands while someone is looking at it. Editing an approved one is allowed and sends it back for review as edited: the brand is live at the carrier, so a change has to be looked at again.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Agent identifier, as returned on creation.

Body Params

Fields of a full replacement of an existing registration. Same shape as RcsAgentCreate, with one difference: use_case is optional here.

It is optional because the brand already declared it on creation, and because it stops being changeable the moment the brand is approved — approval registers it in one of the supplier's projects, and moving it afterwards only makes the send look for the brand in a project where it does not exist (409 with use_case_locked, naming the projects the brand is registered in). Omitting it keeps whatever was declared; sending the same value is accepted; sending a different one on an approved brand is refused. Nothing else about the registration is locked — only this field. A brand that never declared a purpose may still declare one after approval: filling in what was missing is not a change.

Every other field behaves as on creation, this being a replacement and not a patch: what you leave out is cleared.

webhook_url

uri | null

Where this registration's review notifications go — the rcs.agent.status event, fired when the brand is picked up for review, approved or rejected.

It is the agent's own address, not the app's. The webhook URL configured for your app carries campaign events: delivery status and reply-button postbacks. A brand review happens before any of that and usually belongs to a different system of yours, so it is declared here and arrives there alone.

Optional. An agent without it is never notified, and nothing falls back to the app's URL. GET /rcs/agents/{id} still answers the state at any time.

use_case

string

enum

What the brand is for. The carrier homologates the agent against this and suspends whoever leaves it — a verification-code agent sending marketing takes the channel down in days. It also decides which of the supplier's projects the brand is registered in. It does not change after approval: the brand is registered in that project at the supplier, so changing the purpose means registering again.

Allowed:

sender_name

string

required

length ≤ 100

Name shown on the recipient's device. Up to 100 characters.

sender_description

string

required

length ≤ 500

Short description shown alongside the name. Up to 500 characters.

brand_color

string

required

^#[0-9a-fA-F]{6}$

Brand colour in #RRGGBB. Any other format is rejected. It is painted behind white text on the device, so the carrier requires a contrast ratio of at least 4.5:1 against white — a pale colour passes this call and is refused during the review.

logo_url

uri

required

length ≤ 2048

Public URL of the logo. You host the file; we do not accept uploads on this endpoint. The carrier requires a square image of 224×224 pixels, up to 50 KB, in JPEG or PNG — anything else is refused during the review, not on this call.

banner_url

uri

required

length ≤ 2048

Public URL of the banner. Same rule as the logo, with the carrier asking for 1440×448 pixels, up to 200 KB.

contact_name

string

required

length ≤ 255

Person responsible for the registration. Not shown to recipients — we use it to reach you during the review.

contact_email

string

required

length ≤ 255

E-mail of the person responsible. Not shown to recipients.

company_name

string

required

length ≤ 255

Trading name of the company.

legal_name

string

required

length ≤ 255

Registered legal name, as it appears on the company records.

company_website

uri

required

length ≤ 2048

Corporate website. The carrier checks the brand against it.

phone

string

required

length ≤ 20

Public phone number shown to the recipient.

public_email

string

required

length ≤ 255

Public e-mail shown to the recipient.

public_website

uri

required

length ≤ 2048

Public website shown to the recipient.

privacy_policy_url

uri

required

length ≤ 2048

terms_url

uri

required

length ≤ 2048

test_devices

array of strings

length ≤ 20

Phone numbers allowed to receive the agent before it is approved, so you can see the brand on a real device. Not required to submit. Up to 20 numbers.

test_devices

Responses

200Registration replaced.

400The id in the path is not a valid UUID. The agent id is the id returned on creation — a UUID — and not the app id or any other identifier.

401api-token or app-id missing, invalid or blocked.

404No agent with this id belongs to the authenticated account.

422Field validation failed, or an unexpected field was sent.