Skip to main content

LetterResponsePayload

The requested letter or error message related to its retrieval.

type LetterResponsePayload {
  data: Letter
  error: String
  reason: LetterResponseErrorReason
  lockedAt: DateTime
  lockedReason: LetterLockReason
  suggestedAction: LetterLockSuggestedAction
}

Fields​

LetterResponsePayload.data ● Letter object​

LetterResponsePayload.error ● String scalar​

LetterResponsePayload.reason ● LetterResponseErrorReason enum​

Machine-readable error reason when the mutation is rejected.

LetterResponsePayload.lockedAt ● DateTime scalar​

When reason is LETTER_LOCKED, the time the letter was locked.

LetterResponsePayload.lockedReason ● LetterLockReason enum​

When reason is LETTER_LOCKED, why the letter was locked.

LetterResponsePayload.suggestedAction ● LetterLockSuggestedAction enum​

Suggested next action when the letter cannot be edited.

Returned By​

createLetter mutation ● deleteLetter mutation ● updateLetter mutation