ORory
courier

Get a Message

Gets a specific messages by the given ID.

get/admin/courier/messages/{id}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /admin/courier/messages/{id}
  • Auth
    API key in header Authorization

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
statusinteger 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' | 'verifiable_address_changed' | 'authenticator_key_added' 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 verifiable_address_changed TypeVerifiableAddressChanged authenticator_key_added TypeAuthenticatorKeyAdded

typeinteger required

It can either be email or phone

updated_atstring date-time required

UpdatedAt is a helper struct field for gobuffalo.pop.

Changes

No recorded changes to this operation across all 65 revisions of this API.