All API categories

    Communications API

    19 endpoints

    Communication templates and messaging.

    PATCH
    Auth Required

    Admin: Get current comms settings for a collection.

    Admin: Get current comms settings for a collection.

    Endpoint

    /admin/collection/{collectionId}/comm.settings

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    object
    Required

    Request body

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Public: Register a Web Push subscription under unified comms.

    Public: Register a Web Push subscription under unified comms.

    Endpoint

    /admin/collection/{collectionId}/comm.settings{qs}

    Parameters

    collectionId
    path
    string
    Required
    qs
    path
    string
    Required
    includeSecret
    query
    string

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Logging: Append a single communication event.

    Logging: Append a single communication event.

    Endpoint

    /admin/collection/{collectionId}/comm/log

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    LogCommunicationEventBody
    Required

    See LogCommunicationEventBody schema

    Responses

    200
    Success
    {
  "schema": "AppendResult"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Logging: Append a single communication event.

    Logging: Append a single communication event.

    Endpoint

    /admin/collection/{collectionId}/comm/log/bulk

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    object
    Required

    Request body

    Responses

    200
    Success
    {
  "schema": "AppendBulkResult"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Public: Resolve contacts for a subject with identity hints.

    Public: Resolve contacts for a subject with identity hints.

    Endpoint

    /admin/collection/{collectionId}/comm/query/by-user

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    CommsQueryByUser
    Required

    See CommsQueryByUser schema

    Responses

    200
    Success
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Analytics: Query communication events by user or contact.

    Analytics: Query communication events by user or contact.

    Endpoint

    /admin/collection/{collectionId}/comm/query/recipient-ids

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    CommsRecipientIdsQuery
    Required

    See CommsRecipientIdsQuery schema

    POST
    Auth Required

    Analytics: Recipients who did not perform an action.

    Analytics: Recipients who did not perform an action.

    Endpoint

    /admin/collection/{collectionId}/comm/query/recipients/with-action
    POST
    Auth Required

    Analytics: Recipient IDs for a communication source.

    Analytics: Recipient IDs for a communication source.

    Endpoint

    /admin/collection/{collectionId}/comm/query/recipients/without-action
    POST
    Auth Required

    Send a single transactional message to one contact using a template.

    Send a single transactional message to one contact using a template.

    Endpoint

    /admin/collection/{collectionId}/comm/send
    POST
    Auth Required

    Public: List registered contact methods.

    Public: List registered contact methods.

    Endpoint

    /public/collection/{collectionId}/comm/email/register
    GET
    Auth Required

    Public: Check subscription status for a subject.

    Public: Check subscription status for a subject.

    Endpoint

    /public/collection/{collectionId}/comm/methods{qs}
    POST
    Auth Required

    Communications namespace for sending notifications and managing user communications / export namespace comms { /** Public: Get VAPID public key used for Web Push subscriptions.

    Communications namespace for sending notifications and managing user communications / export namespace comms { /** Public: Get VAPID public key used for Web Push subscriptions.

    Endpoint

    /public/collection/{collectionId}/comm/push/register
    GET
    Auth Required

    Communications namespace for sending notifications and managing user communications / export namespace comms { /** Public: Get VAPID public key used for Web Push subscriptions.

    Communications namespace for sending notifications and managing user communications / export namespace comms { /** Public: Get VAPID public key used for Web Push subscriptions.

    Endpoint

    /public/collection/{collectionId}/comm/push/vapidPublicKey
    POST
    Auth Required

    Public: Register email method for a contact.

    Public: Register email method for a contact.

    Endpoint

    /public/collection/{collectionId}/comm/sms/register
    POST
    Auth Required

    Public: Upsert preferences for a specific subject (or default if subject omitted).

    Public: Upsert preferences for a specific subject (or default if subject omitted).

    Endpoint

    /public/collection/{collectionId}/comm/subscribe
    GET
    Auth Required

    Public: Subscribe/unsubscribe contact to a subject.

    Public: Subscribe/unsubscribe contact to a subject.

    Endpoint

    /public/collection/{collectionId}/comm/subscription/check{qs}
    POST
    Auth Required

    Public: Register SMS method for a contact.

    Public: Register SMS method for a contact.

    Endpoint

    /public/collection/{collectionId}/comm/subscriptions/resolve
    GET
    Auth Required

    Admin: Patch comms settings for a collection.

    Admin: Patch comms settings for a collection.

    Endpoint

    /public/collection/{collectionId}/comm/topics
    GET
    Auth Required

    Public: Fetch configured topics for a collection.

    Public: Fetch configured topics for a collection.

    Endpoint

    /public/collection/{collectionId}/comm/unsubscribe{qs}