Opero APIcompanies
Cancel a queued email send
Authorization
api-token AuthorizationBearer <token>
Opero API token. Send it as Authorization: Bearer ek_...
In: header
Path Parameters
companyId*string
messageId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/companies/string/email/messages/string/cancel-send" \ -H "Content-Type: application/json" \ -d '{ "clientMutationId": "string", "expectedVersion": 1 }'{ "data": { "isAutoReply": true, "isDeliveryReport": true, "isListMail": true, "sentCopyState": "PROVIDER", "sendIdentityId": "string", "id": "string", "accountId": "string", "threadId": "string", "subject": "string", "snippet": "string", "fromAddresses": [ { "address": "string", "name": "string" } ], "toAddresses": [ { "address": "string", "name": "string" } ], "ccAddresses": [ { "address": "string", "name": "string" } ], "direction": "INBOUND", "origin": "SYNC", "deliveryStatus": "DRAFT", "remoteAvailability": "PRESENT", "receivedAt": "2019-08-24T14:15:22Z", "sentAt": "2019-08-24T14:15:22Z", "isRead": true, "isFlagged": true, "attachmentCount": 0, "version": 0, "remoteDraftState": { "localRevision": 0, "synchronizedRevision": 0, "remoteOccurrenceId": "string", "status": "LOCAL_ONLY", "lastError": "string", "updatedAt": "2019-08-24T14:15:22Z" }, "deliveryReports": [ { "address": "string", "status": "BOUNCED", "enhancedStatus": "string", "diagnostic": "string", "reportMessageId": "string", "observedAt": "2019-08-24T14:15:22Z" } ], "undoUntil": "2019-08-24T14:15:22Z", "bccAddresses": [ { "address": "string", "name": "string" } ], "replyToAddresses": [ { "address": "string", "name": "string" } ], "bodyText": "string", "bodyHtml": "string", "attachments": [ { "id": "string", "messageId": "string", "filename": "string", "mimeType": "string", "sizeBytes": 0, "contentId": "string", "isInline": true, "fileId": "string", "state": "PENDING" } ], "occurrences": [ { "id": "string", "accountId": "string", "messageId": "string", "folderId": "string", "protocolGeneration": "string", "remoteKey": "string", "kind": "REMOTE", "sourceOccurrenceId": "string", "remoteFlags": [ "string" ], "remoteLabels": [ "string" ], "observedAt": "2019-08-24T14:15:22Z", "remoteState": "PRESENT" } ], "compositionContext": { "signatureText": "string", "signatureHtml": "string", "quotedText": "string", "quotedHtml": "string", "quoteOriginal": true } }}{ "error": { "code": "NOT_FOUND", "message": "Resource not found", "meta": { "partiallyApplied": true, "failedPhase": "defaultForms", "committedObjects": [ { "id": "5e2af9bc-be0b-4ad8-af57-e8319fb115d3", "key": "session", "created": true } ], "fieldsWritten": 1, "fieldsDeleted": 0 }, "fieldErrors": { "name": [ "Field \"name\" is required" ] }, "unavailableMutationScopes": [ "contractor.bankAccounts" ], "clientMutationId": "019f2e3a-7c8b-7a33-9fc8-90db2b5b1e50", "relationTableErrors": {}, "idempotencyConflict": {}, "errors": [ { "message": "relation \"foo\" does not exist" } ], "impacts": [ {} ], "validation": {} }}