Skip to content
campaiDeveloper
campai.com

Crm · Contacts

GET/{organizationId}/{mandateId}/crm/contactMessages/{contactBulkMessageId}Reads only

Get contact message progress

Gets the progress of a direct contact message for an organization and mandate. It takes the organization, mandate and contact bulk message IDs, and returns the message ID, design revision and retained recipient-admission state and failure.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have organization access with dispatchDocument.read.
  • The caller must have mandate.read for the requested mandate.
  • For each contact type on the message, the caller needs the corresponding read permission: contact:member.read, contact:address.read, contact:customer.read, contact:sponsor.read, contact:contributor.read, contact:employee.read or contact:supplier.read.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • contactBulkMessageIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/contactMessages/YOUR_CONTACT_BULK_MESSAGE_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • _idid
  • designRevisionnumber
  • recipientAdmissionobjectnullable

    recipientAdmission is null when the message has no recipient-admission data.

    3 properties
    • statestring
      pending processing complete failed
    • errorstringnullable
    • nextAttemptAtstring · date-timenullable
Response200
{
  "_id": "000000000000000000000001",
  "designRevision": 1,
  "recipientAdmission": {
    "state": "pending",
    "error": "string",
    "nextAttemptAt": "2026-06-15T22:30:00Z"
  }
}

Errors

Other errors

StatusErrorWhen
403No fixed messageIf the caller lacks read access to any contact type on the message, the endpoint returns HTTP 403 (FORBIDDEN). No message key is specified.
404No fixed messageIf no matching message is found, the endpoint returns HTTP 404 (NOT_FOUND). No message key is specified.

Errors nearly every request can meet are listed under Errors.