RCS

Request an RCS agent

Requests a new agent for a profile, with a new company (brand) or an existing one (brandId, skips vetting when it is already verified). The request lands in our review: nothing is filed with the carriers or billed until we submit it. A profile can hold several agents. Requires usage-based billing and a card on file. Send an Idempotency-Key header to make retries safe.

post/v1/rcs/agents

Headers

Idempotency-Keystring

Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.

Request body

profileIdstring required
brandIdstring
displayNamestring required

Shown as the sender name.

useCase'MULTI_USE' | 'PROMOTIONAL' | 'TRANSACTIONAL' | 'OTP' required
smsFallbackFromstring

One of your SMS-enabled numbers. Phones without RCS get the message as SMS from it.

Response

Agent requested.

Changes

Changed in 3 of the 65 revisions of this API.10

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      removed the platform enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog