Expand description
Request and response shapes of the SendClipper REST API (/v1).
The API only ever ADDS fields inside /v1; it never removes or retypes
one. Unknown response fields are ignored, and a missing one takes its
default. Timestamps are ISO 8601 strings, exactly as the API sends them.
Structs§
- ApiKey
- One of the workspace’s keys, masked.
- Attachment
- One file on
emails().send()/sandboxes().send(). - Audience
- A list of contacts.
- Audience
List - Every audience.
- Batch
Item Error - Why one batch item was refused.
- Batch
Result - One submitted item’s outcome:
statusis"accepted"(idset) or"failed"(errorset). - Batch
Summary - Counts for a batch.
- Contact
- One person in an audience.
- Contact
List - One numbered page of contacts.
- Create
Contact Params - Adds a contact.
- Create
Domain Params - Registers a domain.
- Cursor
Info - The paging block of a cursor-addressed list.
- DnsRecord
- One DNS record to publish.
- Domain
- A sending (and optionally receiving) domain.
- Domain
Check - One SPF/DKIM/DMARC check.
- Domain
Records - A domain with the DNS records to publish.
- Downloaded
File - What a download returns.
- Email
Detail - One message with its body and timeline.
- Email
Event - One step of a message’s timeline.
- Email
List - One numbered page of the log.
- Email
Row - One message in the log.
- Email
Stats - Counts per status.
- Import
Contacts Params - A CSV or vCard import.
- List
Contacts Params - Filters for contacts.
- List
Emails Params - Filters for the sent-mail log.
- List
Mailbox Messages Params - Filters for an address’s mail.
- List
Sandbox Messages Params - Filters for a sandbox’s messages.
- List
Suppressions Params - Filters for the list.
- List
Templates Params - Filters for the template list.
- List
Webhook Deliveries Params - Filters for delivery attempts.
- List
Webhook Dispatches Params - Filters for undelivered events.
- Mailbox
- One address on a receiving domain.
- Mailbox
Attachment - One attachment of a received message.
- Mailbox
Message - One message in full, with its conversation.
- Mailbox
Message List - One cursor page of a mailbox.
- Mailbox
Message Row - One message in a mailbox list.
- Mailbox
Params - Creates or changes an address.
- Message
Header - One header of a trapped message.
- Named
Ref - An
{ id, name }pair. - Preview
Variable - One tag a preview filled.
- Replay
AllResult - What a bulk replay queued.
- Reset
Sandbox Credentials - The new credentials. The token is shown once.
- Sandbox
- A sandbox: it traps mail, and nothing sent to it is delivered.
- Sandbox
Credentials - Points a project at a sandbox.
- Sandbox
Message - One trapped message in full.
- Sandbox
Message Summary - One trapped message in a list.
- Sandbox
Params - Creates or renames a sandbox.
- Sandbox
Send Result - What the sandbox JSON door answers.
- Send
Batch Response - One result per submitted item, in order.
- Send
Email Params - One message. Give it a body (
subject+html) or a published template (template_idortemplate, plusvariables). - Sent
Email - What
emails().send()answers: the message was accepted (queued). - Suppression
- Stops mail to one address.
- Suppression
Counts - Counts on the list.
- Suppression
Created createdis false when the address was already suppressed;rowis the entry either way.- Suppression
List - One cursor page of the list.
- Template
- A template with its body.
- Template
Asset - An uploaded image.
- Template
Params - Creates or changes a template. Every field is optional; on an update only the fields you set change.
- Template
Preview - A render that sent nothing.
- Template
Summary - One card in the template list.
- Template
Tag - A template tag.
- Webhook
Dispatch - One event’s delivery to one endpoint.
- Webhook
Dispatch Page - One cursor page of dispatches.
- Webhook
Endpoint - A URL SendClipper posts events to.
- Webhook
Event - A webhook delivery’s body.
- Webhook
Params - Registers or changes an endpoint.
- Workspace
- The workspace an API key belongs to.
Type Aliases§
- Object
- A JSON object, for open-ended fields.