Messages

List Messages

get

Retrieve recent project outreach messages for reporting or auditing with optional calendar bounds on a chosen message datetime column.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

channelstring · enum · nullableOptional

Filter messages by delivery channel.

Possible values:

date_fromstring · date · nullableOptional

Inclusive lower calendar date (YYYY-MM-DD) for the column chosen by date_key, defaulting to created_at when date_key is omitted.

date_keystring · enum · nullableOptional

Message datetime column paired with date_from and date_to (defaults to created_at when omitted).

Possible values:

date_tostring · date · nullableOptional

Inclusive upper calendar date (YYYY-MM-DD) for the column chosen by date_key; must be on or after date_from when both bounds are provided.

template_slugstring · nullableOptional

Filter messages by template slug prefix.

statusstring · enum · nullableOptional

Filter messages by delivery status.

Possible values:

sort_keystring · enum · nullableOptional

Message timestamp field to sort by.

Possible values:

sort_dirstring · enum · nullableOptional

Sort direction: asc or desc.

Possible values:

limitinteger · nullableOptional

Maximum number of records to return.

Responses

200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get/messages

GET /project/messages HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": [
    {
      "id": 55,
      "uuid": "74340248-84bb-4ed4-9b85-2f8a6efc9964",
      "ask_id": 32,
      "channel": "email",
      "failed_reason": null,
      "scheduled_at": 1714507200,
      "processed_at": 1714507260,
      "sent_at": 1714507320,
      "delivered_at": 1714507380,
      "opened_at": 1714510800,
      "clicked_at": null,
      "failed_at": null,
      "complained_at": null,
      "canceled_at": null,
      "halted_at": null,
      "created_at": 1714507200,
      "updated_at": 1714510800,
      "customer": {
        "id": 101,
        "uuid": "c53958ca-dfa3-4804-b711-0b7e61e7d8de",
        "name": "Alex Johnson",
        "color": "#4F46E5",
        "gravatar": "https://www.gravatar.com/avatar/7c6a180b36896a0a8c02787eeafb0e4c",
        "platform_url": "https://app.example.com/projects/42/customers/101",
        "unsubscribed_at": null
      },
      "template": {
        "id": 4,
        "uuid": "7f0c19b1-e9cb-48ef-a021-2f6ed0041c39",
        "name": "Review Request",
        "slug": "review-request",
        "channel": "email"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/project/messages",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}

Delete Message

delete

Delete a scheduled or sent outreach message for the authenticated project.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Unique numeric identifier for this message.

Responses

200

Success

application/json

Confirms the message was deleted and related ask completion was refreshed when applicable.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by this API.

delete/messages/{id}

DELETE /project/messages/{id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200
}