Skip to main content

DocumentActionResponse

Response for document actions.

type DocumentActionResponse {
  success: Boolean!
  message: String
  error: String
  contents: String
  filename: String
  primary: DocumentDeliveryPrimaryResult
  bcc: DocumentDeliveryQueue
}

Fields​

DocumentActionResponse.success ● Boolean! non-null scalar​

Whether the action was successful.

DocumentActionResponse.message ● String scalar​

Optional success message.

DocumentActionResponse.error ● String scalar​

Error message if the action failed.

DocumentActionResponse.contents ● String scalar​

Base64 encoded contents of the file.

DocumentActionResponse.filename ● String scalar​

The name of the file.

DocumentActionResponse.primary ● DocumentDeliveryPrimaryResult object​

The message sent to the To and CC recipients. Set on a successful send through Exchange.

DocumentActionResponse.bcc ● DocumentDeliveryQueue object​

The BCC recipients' messages, queued one per recipient. Set on a successful send through Exchange with BCC recipients who are not also To or CC recipients.

Returned By​

documentAction mutation ● sendEmail mutation ● templateRender mutation