Updated October 29, 2026
Communications API
Explore 18 documented operations, including request parameters, body schemas, and responses.
Operations
Choose an operation to view its contract and a request example. Authentication and environment availability depend on the route.
DELETE
Release Communication Suppression
/v1/communication-suppressions/{suppression_id}GET
Get Packaged Template Default
/v1/communication-templates/defaults/{default_key}POST
Preview Communication Template
/v1/communication-templates/previewDELETE
Delete Communication Template
/v1/communication-templates/{template_id}GET
Get Communication Template
/v1/communication-templates/{template_id}PATCH
Update Communication Template
/v1/communication-templates/{template_id}GET
List Template Versions
/v1/communication-templates/{template_id}/versionsGET
Get Communication
/v1/communications/{communication_id}POST
Link Communication
/v1/communications/{communication_id}/linkGET
List Facility Suppressions
/v1/facilities/{facility_id}/communication-suppressionsPOST
Create Facility Suppression
/v1/facilities/{facility_id}/communication-suppressionsGET
List Facility Templates
/v1/facilities/{facility_id}/communication-templatesPOST
Create Facility Template
/v1/facilities/{facility_id}/communication-templatesGET
List Facility Communications
/v1/facilities/{facility_id}/communicationsPOST
Send Communication
/v1/facilities/{facility_id}/communicationsGET
Get Communication Counts
/v1/facilities/{facility_id}/communications/countsPOST
Mark Communications Read
/v1/facilities/{facility_id}/communications/readGET
List Merge Fields
/v1/merge-fieldsTry a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Response
Your response will appear here.