API ReferenceCampaignsRCS

Upsert RCS Campaign

Create a new RCS campaign or updates an existing one.

Omit campaignId to create a campaign.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
agentobjectOptional
Create an agent for the campaign.
brandVerificationUrlstringOptional
Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website.
brandstringOptional
Unique identifier for the brand.
campaignIdstringOptional
Unique identifier for the campaign.
expectedAgentResponseslist of stringsOptional

List of what the agent might say to users (1-5 required).

optInobjectOptional

Opt-in configuration.

optOutobjectOptional

Opt-out configuration.

useCaseobjectOptional
Use case classification for the campaign.

Response

Successfully created or updated RCS campaign.
agentobject
Agent configured to the campaign.
agentIdstring
Agent's unique identifier.
brandobject
Brand associated with this campaign.
brandAttestationboolean
Indicates whether the brand has provided an attestation.
statusenum

Current review status of the campaign.

INCOMPLETE: Not submitted.

IN REVIEW: Being reviewed by carriers.

VERIFIED: Approved and ready to send messages.

FAILED: Issues and errors related to the campaign’s details.

Allowed values:
brandVerificationUrlstring or null
Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website.
campaignIdstring or null

Unique identifier for the campaign. This identifier is a string that always begins with the prefix rcs_, for example: rcs_1234567890.

expectedAgentResponseslist of strings or null
List of what the agent might say to users.
optInobject or null

Opt-in configuration.

optOutobject or null

Opt-out configuration.

useCaseobject or null
Use case classification for the campaign.

Errors