Skip to main content

Servers

Servers​

The Servers API allows you to list, view, create, and modify the servers that store your SMS and email messages.

List all servers​

GET: /api/servers

Returns a list of your virtual SMTP servers. Servers are returned sorted in alphabetical order.

Create a server​

POST: /api/servers Creates a new virtual SMTP server and returns it.

Body parameters​

name: String

The name of the server.

Retrieve a server​

GET /api/servers/:id Retrieves the detail for a single server. Simply supply the unique identifier for the required server.

Path parameters​

id: String The identifier of the server to be retrieved.

Retrieve server password​

GET: /api/servers/:id/password

Retrieves the password, for use with SMTP and POP3, for a single server. Simply supply the unique identifier for the required server.

Path parameters​

id: String

The identifier of the server.

Update a server​

PUT: /api/servers/:id

Updates a single server and returns it.

Path parameters​

id: String

The identifier of the server to be updated.

name: String

The name of the server.

Delete a server​

DELETE: /api/servers/:id

Permanently deletes a server. This operation cannot be undone. Also deletes all messages and associated attachments within the server.

Path parameters​

id: String The identifier of the server to be deleted.