API reference
Minket API 1.0.0: every operation of the API, generated from the OpenAPI document.
The API lives at https://api.minket.com/v1. Authenticate with Authorization: Bearer <api key>; the quickstart covers authentication, pagination and errors, and API keys the scopes. POSTs take an Idempotency-Key. The operation ids are the names in every SDK, the CLI's minket api and the OpenAPI document; the explorer shows the same document interactively.
Groups
- Emails
Send, batch, schedule, reschedule and cancel mail, and read it with its timeline. 10 operations.
- Attachments
Reusable attachments: upload once, reference by id in any number of emails. 4 operations.
- Uploads
Presigned uploads for attachments above 4 MB and large contact imports. 2 operations.
- Templates
Hosted templates with typed variables, versions and previews. 10 operations.
- Domains
Sending and receiving domains, DNS records, verification and deliverability. 9 operations.
- Webhooks
Signed webhook endpoints, their deliveries, replays and test events. 10 operations.
- Events
The event feed: every event webhooks deliver, readable with a cursor. 2 operations.
- Inbound
Received mail with verdicts and attachments, routing rules and forwarding. 10 operations.
- Mailboxes
Connected Gmail, Microsoft and SMTP mailboxes to send as a person. 4 operations.
- Suppressions
Addresses that are never sent to, by reason and stream. 3 operations.
- Contacts
Contacts with properties, consent, double opt-in, imports, exports and custom events. 15 operations.
- Segments
Static and rule-based segments of the audience. 8 operations.
- Topics
Subscription topics shown on the preference center. 5 operations.
- Broadcasts
Marketing sends to a segment: drafts, scheduling, A/B tests and recipients. 11 operations.
- Automations
Workflows triggered by events, their versions and runs. 11 operations.
- Keys
API keys of the project, and the calling key itself. 4 operations.
- Logs
API request logs with status, latency, key and error code. 2 operations.
- Members
Members of the organization and their roles. 1 operation.
All 121 operations
| Operation | Request | Summary |
|---|---|---|
getEmailMetrics | GET /v1/emails/metrics | Get email metrics |
sendEmail | POST /v1/emails | Send an email |
listEmails | GET /v1/emails | List emails |
sendBatch | POST /v1/emails/batch | Send up to 100 emails |
getEmail | GET /v1/emails/{id} | Get an email |
rescheduleEmail | PATCH /v1/emails/{id} | Reschedule a scheduled email |
cancelEmail | POST /v1/emails/{id}/cancel | Cancel a scheduled email |
listEmailEvents | GET /v1/emails/{id}/events | Get an email's event timeline |
listEmailAttachments | GET /v1/emails/{id}/attachments | List an email's attachments with download URLs |
shareEmail | POST /v1/emails/{id}/share | Share an email |
createAttachment | POST /v1/attachments | Store a reusable attachment (inline up to 4 MB, or from an upload) |
listAttachments | GET /v1/attachments | List reusable attachments |
getAttachment | GET /v1/attachments/{id} | Get a reusable attachment with a download URL |
deleteAttachment | DELETE /v1/attachments/{id} | Delete a reusable attachment |
createUpload | POST /v1/uploads | Create a presigned upload |
getUpload | GET /v1/uploads/{id} | Get an upload's status |
createTemplate | POST /v1/templates | Create a hosted template |
listTemplates | GET /v1/templates | List templates |
getTemplate | GET /v1/templates/{id} | Get a template (by id or alias) |
updateTemplate | PATCH /v1/templates/{id} | Update a template (creates a new draft version) |
deleteTemplate | DELETE /v1/templates/{id} | Delete a template |
publishTemplate | POST /v1/templates/{id}/publish | Publish the current draft version |
duplicateTemplate | POST /v1/templates/{id}/duplicate | Duplicate a template |
listTemplateVersions | GET /v1/templates/{id}/versions | List a template's versions |
getTemplateVersion | GET /v1/templates/{id}/versions/{version} | Get one version |
previewTemplate | POST /v1/templates/{id}/preview | Render a template with variables |
createDomain | POST /v1/domains | Add a sending or receiving domain |
listDomains | GET /v1/domains | List domains |
getDomain | GET /v1/domains/{id} | Get a domain with its DNS records |
updateDomain | PATCH /v1/domains/{id} | Update a domain |
deleteDomain | DELETE /v1/domains/{id} | Remove a domain |
verifyDomain | POST /v1/domains/{id}/verify | Check DNS and SES verification now |
listDomainDmarcReports | GET /v1/domains/{id}/dmarc | List DMARC aggregate reports for a domain |
getDomainReputation | GET /v1/domains/{id}/reputation | Postmaster and seed-test history for a domain |
runSeedTest | POST /v1/domains/{id}/seedtest | Run an inbox placement test now |
createWebhook | POST /v1/webhooks | Create a webhook endpoint |
listWebhooks | GET /v1/webhooks | List webhook endpoints |
getWebhook | GET /v1/webhooks/{id} | Get a webhook endpoint |
updateWebhook | PATCH /v1/webhooks/{id} | Update a webhook endpoint |
deleteWebhook | DELETE /v1/webhooks/{id} | Delete a webhook endpoint |
rotateWebhookSecret | POST /v1/webhooks/{id}/rotate | Rotate the signing secret |
listWebhookDeliveries | GET /v1/webhooks/{id}/deliveries | List deliveries to an endpoint |
getWebhookDelivery | GET /v1/webhooks/{id}/deliveries/{deliveryId} | Get a delivery with its attempt log |
replayWebhookDeliveries | POST /v1/webhooks/{id}/replay | Replay deliveries |
testWebhook | POST /v1/webhooks/{id}/test | Send a test event |
listEvents | GET /v1/events | List events |
getEvent | GET /v1/events/{id} | Get an event |
listInboundRoutes | GET /v1/inbound/routes | List inbound routing rules |
createInboundRoute | POST /v1/inbound/routes | Create an inbound routing rule |
updateInboundRoute | PATCH /v1/inbound/routes/{id} | Update an inbound routing rule |
deleteInboundRoute | DELETE /v1/inbound/routes/{id} | Delete an inbound routing rule |
listInbound | GET /v1/inbound | List received messages |
getInbound | GET /v1/inbound/{id} | Get a received message with its parsed content and verdicts |
listInboundAttachments | GET /v1/inbound/{id}/attachments | List a received message's attachments with download URLs |
getInboundAttachment | GET /v1/inbound/{id}/attachments/{attachmentId} | Get one attachment with a download URL |
forwardInbound | POST /v1/inbound/{id}/forward | Forward a received message |
shareInbound | POST /v1/inbound/{id}/share | Share a received message |
listMailboxes | GET /v1/mailboxes | List connected mailboxes |
createMailbox | POST /v1/mailboxes | Connect a mailbox |
getMailbox | GET /v1/mailboxes/{id} | Get a mailbox |
deleteMailbox | DELETE /v1/mailboxes/{id} | Disconnect a mailbox |
listSuppressions | GET /v1/suppressions | List suppressed addresses |
createSuppression | POST /v1/suppressions | Suppress an address |
deleteSuppression | DELETE /v1/suppressions/{id} | Remove a suppression |
createContact | POST /v1/contacts | Create a contact |
listContacts | GET /v1/contacts | List contacts |
importContacts | POST /v1/contacts/import | Import contacts from CSV |
listImports | GET /v1/contacts/import | List imports |
getImport | GET /v1/contacts/import/{id} | Get an import |
exportContacts | POST /v1/contacts/export | Export contacts as CSV |
sendContactEvent | POST /v1/contacts/events | Send a custom event for a contact |
listContactProperties | GET /v1/contacts/properties | List contact properties |
createContactProperty | POST /v1/contacts/properties | Define a contact property |
deleteContactProperty | DELETE /v1/contacts/properties/{id} | Delete a contact property |
getContact | GET /v1/contacts/{id} | Get a contact (by id or email) |
updateContact | PATCH /v1/contacts/{id} | Update a contact |
deleteContact | DELETE /v1/contacts/{id} | Delete a contact |
listContactConsent | GET /v1/contacts/{id}/consent | Consent ledger for a contact |
sendContactOptin | POST /v1/contacts/{id}/optin | Send a double opt-in confirmation |
createSegment | POST /v1/segments | Create a segment |
listSegments | GET /v1/segments | List segments |
getSegment | GET /v1/segments/{id} | Get a segment |
updateSegment | PATCH /v1/segments/{id} | Update a segment |
deleteSegment | DELETE /v1/segments/{id} | Delete a segment |
listSegmentContacts | GET /v1/segments/{id}/contacts | List a segment's contacts |
addSegmentContacts | POST /v1/segments/{id}/contacts | Add contacts to a static segment |
removeSegmentContacts | DELETE /v1/segments/{id}/contacts | Remove contacts from a static segment |
createTopic | POST /v1/topics | Create a topic |
listTopics | GET /v1/topics | List topics |
getTopic | GET /v1/topics/{id} | Get a topic |
updateTopic | PATCH /v1/topics/{id} | Update a topic |
deleteTopic | DELETE /v1/topics/{id} | Delete a topic |
createBroadcast | POST /v1/broadcasts | Create a broadcast |
listBroadcasts | GET /v1/broadcasts | List broadcasts |
getBroadcast | GET /v1/broadcasts/{id} | Get a broadcast, with its progress and analytics |
updateBroadcast | PATCH /v1/broadcasts/{id} | Update a draft broadcast |
deleteBroadcast | DELETE /v1/broadcasts/{id} | Delete a draft broadcast |
sendBroadcast | POST /v1/broadcasts/{id}/send | Send or schedule a broadcast |
cancelBroadcast | POST /v1/broadcasts/{id}/cancel | Cancel a scheduled or sending broadcast |
duplicateBroadcast | POST /v1/broadcasts/{id}/duplicate | Duplicate a broadcast |
testBroadcast | POST /v1/broadcasts/{id}/test | Send a test copy to up to five addresses |
listBroadcastRecipients | GET /v1/broadcasts/{id}/recipients | List a broadcast's recipients and their status |
listBroadcastLinks | GET /v1/broadcasts/{id}/links | List the links a broadcast's recipients clicked |
createAutomation | POST /v1/automations | Create an automation (draft) |
listAutomations | GET /v1/automations | List automations |
getAutomation | GET /v1/automations/{id} | Get an automation with its current definition |
updateAutomation | PATCH /v1/automations/{id} | Update an automation |
deleteAutomation | DELETE /v1/automations/{id} | Archive an automation |
publishAutomation | POST /v1/automations/{id}/publish | Publish the current version |
stopAutomation | POST /v1/automations/{id}/stop | Pause an automation and stop its waiting runs |
duplicateAutomation | POST /v1/automations/{id}/duplicate | Duplicate an automation |
listAutomationVersions | GET /v1/automations/{id}/versions | List versions |
listAutomationRuns | GET /v1/automations/{id}/runs | List runs |
getAutomationRun | GET /v1/automations/{id}/runs/{runId} | Get a run with its step history |
listKeys | GET /v1/keys | List API keys of the project |
createKey | POST /v1/keys | Create an API key |
getCurrentKey | GET /v1/keys/current | Describe the key making the request |
revokeKey | DELETE /v1/keys/{id} | Revoke an API key |
listLogs | GET /v1/logs | List API request logs |
getLog | GET /v1/logs/{id} | Get one request log entry |
listMembers | GET /v1/members | List members of the organization |