Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-1756158355.3 KB
courier

Get a Message

Gets a specific messages by the given ID.

get/admin/courier/messages/{id}

Path parameters

idstring required

MessageID is the ID of the message.

Response

message

bodystring required
channelstring
created_atstring date-time required

CreatedAt is a helper struct field for gobuffalo.pop.

idstring uuid required
recipientstring required
send_countinteger required
status'queued' | 'sent' | 'processing' | 'abandoned' required

A Message's Status

subjectstring required
template_type'recovery_invalid' | 'recovery_valid' | 'recovery_code_invalid' | 'recovery_code_valid' | 'verification_invalid' | 'verification_valid' | 'verification_code_invalid' | 'verification_code_valid' | 'stub' | 'login_code_valid' | 'registration_code_valid' required

recovery_invalid TypeRecoveryInvalid recovery_valid TypeRecoveryValid recovery_code_invalid TypeRecoveryCodeInvalid recovery_code_valid TypeRecoveryCodeValid verification_invalid TypeVerificationInvalid verification_valid TypeVerificationValid verification_code_invalid TypeVerificationCodeInvalid verification_code_valid TypeVerificationCodeValid stub TypeTestStub login_code_valid TypeLoginCodeValid registration_code_valid TypeRegistrationCodeValid

type'email' | 'phone' required

It can either be email or phone

updated_atstring date-time required

UpdatedAt is a helper struct field for gobuffalo.pop.

Example response

{
  "dispatches": [
    {
      "updated_at": "2000-01-23T04:56:07.000+00:00",
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "message_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "error": "{}",
      "status": "failed"
    },
    {
      "updated_at": "2000-01-23T04:56:07.000+00:00",
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "message_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "error": "{}",
      "status": "failed"
    }
  ],
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "subject": "subject",
  "channel": "channel",
  "recipient": "recipient",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "send_count": 0,
  "template_type": "recovery_invalid",
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "body": "body",
  "type": "email",
  "status": "queued"
}