API Reference
A single searchable index of the RME developer surface.
REST resources
| Method | Path | Description |
|---|---|---|
POST | /rme/v1/messages | Send or schedule one message |
POST | /rme/v1/messages/bulk | Send up to 500 messages |
GET | /rme/v1/messages/{id} | Retrieve message and events |
GET | /rme/v1/messages | Query by contact, status, or date |
DELETE | /rme/v1/messages/{id} | Cancel a scheduled message |
GET | /rme/v1/templates | List templates |
POST | /rme/v1/templates/{name}/render | Preview merged content |
GET | /rme/v1/consent | Read consent state |
POST | /rme/v1/consent | Record consent change |
GET | /rme/v1/suppressions | List suppression entries |
POST | /rme/v1/suppressions | Add a suppression |
DELETE | /rme/v1/suppressions/{id} | Remove a suppression |
POST | /rme/v1/devices | Register a push device |
POST | /rme/v1/events/{provider} | Provider webhook intake |
GET | /rme/v1/health | Provider and configuration health |
Apex classes
| Class | Key members |
|---|---|
RME_Message | builder(), sendAll(), Result |
RME_MessageBuilder | channel(), channels(), strategy(), templateName(), templateLanguage(), toContact(), toAddress(), toPhone(), recordId(), parameter(), parameters(), attachment(), category(), fromDomain(), replyTo(), priority(), schedule(), expiresAfterHours(), aiBlock(), build(), send() |
RME_Scheduler | cancel(), reschedule(), pending() |
RME_Consent | isGranted(), grant(), revoke(), history() |
RME_Suppression | isSuppressed(), add(), remove(), list() |
RME_TemplateRenderer | render(), preview(), Preview |
RME_DeliveryStatus | get(), events(), contactIdFor() |
RME_Diagnostics | run(), Result |
RME_Test | mockProvider(), mockEvent() |
Flow actions
Send Message (RME) · Schedule Message (RME) · Cancel Scheduled Message (RME) · Check Consent (RME) · Add to Suppression (RME) · Render Template (RME) · Get Delivery Status (RME)
Platform Events
RME_Delivery_Event__e · RME_Message_Failed__e · RME_Inbound_Message__e · RME_Consent_Changed__e · RME_Provider_Health__e
Objects
Message__c · Delivery_Status__c · Delivery_Attempt__c · Message_Reply__c · Message_Tracking__c · Template__c · Provider_Config__c · Sending_Domain__c · Consent__c · Suppression__c · Audit_Log__c · RME_Device__c · Outbound_Webhook__c
Status values
| Value | Meaning |
|---|---|
QUEUED | Accepted, awaiting dispatch |
SCHEDULED | Held for a future send time |
SENT | Handed to the provider |
DELIVERED | Provider confirmed delivery |
FAILED | Retry policy exhausted |
SUPPRESSED | Blocked by suppression or consent |
EXPIRED | Not sent within its validity window |
CANCELLED | Cancelled before dispatch |
Error codes
INVALID_PAYLOAD · UNAUTHORIZED · NO_CONSENT · SUPPRESSED · INVALID_ADDRESS · TEMPLATE_NOT_FOUND · DOMAIN_NOT_VERIFIED · RATE_LIMITED · PROVIDER_ERROR · CIRCUIT_OPEN · QUIET_HOURS
Versioning
The REST path carries the major version (/v1). Additive changes ship without a version bump; breaking changes ship as /v2 with at least twelve months of overlap. Apex global signatures in a managed package are permanent — deprecated members are annotated, never removed.
Continue to Enterprise Intelligence.
Was this helpful?
Last updated 1 month ago