API endpoints reference

Complete reference for the Vend Email API endpoints.

Domains

View domains available to use in your account.

List domains

Retrieve a list of all domains in your account.

GET /api/v1/domains

Get domain

Get details about a specific domain.

GET /api/v1/domains/:id

Forwarders

Manage email forwarding addresses and their configurations.

List forwarders

Retrieve a list of all forwarders in your account.

GET /api/v1/forwarders

Get forwarder

Get details about a specific forwarder.

GET /api/v1/forwarders/:id

Create forwarder

Create a new email forwarder.

POST /api/v1/forwarders
{
  "local_part": "sales",
  "domain_id": 1,
  "name": "John Doe",
  "recipients": "[email protected], [email protected]",
  "title": "Sales inquiries",
  "description": "Forward sales inquiries to the sales team",
  "supporting_details": "Include any additional information here",
  "tags_string": "Sales, Inquiries",
  "price": 0.00
}

Update forwarder

Update an existing forwarder's configuration.

PATCH /api/v1/forwarders/:id
{
  "name": "Jane Doe"
}

Delete forwarder

Remove a forwarder.

DELETE /api/v1/forwarders/:id

Safe senders

Manage your list of approved email senders.

List safe senders

Get all approved sender addresses.

GET /api/v1/safe-senders

Get safe sender

Get details about a specific safe sender.

GET /api/v1/safe-senders/:id

Add safe sender

Add a new approved sender.

POST /api/v1/safe-senders
{
  "email": "[email protected]"
}

Remove safe sender

Remove an address from approved senders.

DELETE /api/v1/safe-senders/:id

Unsafe senders

Manage your list of blocked email senders.

List unsafe senders

Get all blocked sender addresses.

GET /api/v1/unsafe-senders

Get unsafe sender

Get details about a specific unsafe sender.

GET /api/v1/unsafe-senders/:id

Add unsafe sender

Add a new blocked sender.

POST /api/v1/unsafe-senders
{
  "email": "[email protected]"
}

Remove Unsafe sender

Remove an address from blocked senders.

DELETE /api/v1/unsafe-senders/:id

Tags

Manage tags for organizing forwarders.

List tags

Get all tags in your account.

GET /api/v1/tags

Get tag

Get details about a specific tag.

GET /api/v1/tags/:id

Create tag

Create a new tag.

POST /api/v1/tags
{
  "name": "Productivity",
}

Update tag

Update an existing tag.

PATCH /api/v1/tags/:id
{
  "name": "Sales",
}

Delete tag

Remove a tag.

DELETE /api/v1/tags/:id