Zernio
Zernio
API Reference

Rcs

List RCS agentsGETList RCS brandsGETList RCS test phonesGETRequest an RCS agentPOSTGet an RCS agentGETCheck RCS capabilityGETUpdate an RCS agentPATCHInvite an RCS test phonePOSTDeactivate an RCS agentDELETERemove an RCS test phoneDELETESend the launch filingPOSTSend an RCS messagePOSTUpload an RCS logo or bannerPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Rcs

Update an RCS agent

Edits the filing while the agent is requested or changes_requested; answering a change request puts it back in our review. The company can only change until it is filed. smsFallbackFrom stays editable in any status (null removes it).

PATCH
/v1/rcs/agents/{agentId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

agentId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.rcs.updateRcsAgent({  path: {    agentId: 'agent_abc123',  },  body: {    displayName: 'Example',    useCase: 'MULTI_USE',    profile: {      description: 'Hello, world!',      logoUrl: 'https://example.com',      heroUrl: 'https://example.com',      brandColor: 'string',      privacyPolicyUrl: 'https://example.com',      termsUrl: 'https://example.com',    },  },});console.log(data);
{  "agent": {    "id": "string",    "profileId": "string",    "accountId": "string",    "country": "string",    "status": "requested",    "displayName": "string",    "useCase": "MULTI_USE",    "profile": {      "description": "string",      "logoUrl": "http://example.com",      "heroUrl": "http://example.com",      "brandColor": "string",      "privacyPolicyUrl": "http://example.com",      "termsUrl": "http://example.com",      "phone": {        "number": "string",        "label": "string"      },      "website": {        "url": "http://example.com",        "label": "string"      },      "email": {        "address": "user@example.com",        "label": "string"      }    },    "brand": {      "displayName": "string",      "legalName": "string",      "legalEntityType": "LIMITED_LIABILITY_COMPANY",      "organizationType": "PRIVATE_PROFIT",      "websiteUrl": "http://example.com",      "taxId": "string",      "stockSymbol": "string",      "address": {        "line1": "string",        "line2": "string",        "city": "string",        "state": "string",        "postalCode": "string",        "country": "US"      },      "contact": {        "firstName": "string",        "lastName": "string",        "title": "string",        "email": "user@example.com",        "phone": "string"      },      "id": "string",      "status": "draft",      "createdAt": "2019-08-24T14:15:22Z"    },    "launchRequest": {      "companyOverview": "string",      "agentOverview": "string",      "interactions": [        {          "type": "TRANSACTIONAL_UPDATES",          "description": "string"        }      ],      "messageExamples": [        "string",        "string",        "string"      ],      "consent": {        "optInMethods": [          {            "type": "SMS",            "description": "string"          }        ],        "callToAction": "string",        "callToActionUrl": "http://example.com",        "callToActionMediaUrl": "http://example.com",        "doubleOptIn": true,        "doubleOptInMessage": "string",        "optInMessage": "string",        "helpResponse": "string",        "optOutResponse": "string"      },      "testVideoUrl": "http://example.com",      "additionalInformation": "string"    },    "carrierApprovals": [      {        "approvalId": "string",        "scope": "carrier",        "status": "PENDING",        "carrier": "string",        "approvedAt": "2019-08-24T14:15:22Z",        "rejectedReason": "string"      }    ],    "testDevices": [      {        "testDeviceId": "string",        "phoneNumber": "string",        "inviteStatus": "PENDING"      }    ],    "smsFallbackFrom": "string",    "reviewNote": "string",    "declineReason": "string",    "requestedAt": "2019-08-24T14:15:22Z",    "submittedAt": "2019-08-24T14:15:22Z",    "liveAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  }}
Was this page helpful?

Check RCS capability

Which recipients can receive RCS from the agent and which rich features their phones support. Up to 100 numbers.

Invite an RCS test phone

Invites a phone to try the agent before launch. It must accept the invite in its messaging app. Available once the agent exists with the carriers (after brand vetting). T-Mobile and AT&T numbers cannot be test phones.

displayName?string
Lengthlength <= 40
useCase?string

Value in

  • "MULTI_USE"
  • "PROMOTIONAL"
  • "TRANSACTIONAL"
  • "OTP"
profile?

The agent's public profile. At least one of phone, website or email is required.

brand?
smsFallbackFrom?string|null