Sign in

v1

latestOpenAPI 3.0.02026-07-135965404.0 KB
Email Lists

Create new email list

Create a new email list. Among other things, email lists can be used to send files or share folders with a group of email addresses at once.

post/email-lists

Headers

ev-api-keystring required

API Key required to make the API call.

ev-access-tokenstring required

Access token required to make the API call.

Request body

namestring required

Name of the email list.

emailsstring[] required

Array of email addresses to include in the email list.

Example request

{
  "name": "My friends list",
  "emails": [
    "johns@example.com",
    "jdoe@example.com"
  ]
}

Response

Successful operation

responseStatusinteger

Http Status code

Example response

{
  "responseStatus": 200,
  "included": [
    {
      "id": 655621,
      "type": "user",
      "attributes": {
        "status": 1,
        "expiration": "2020-06-30T13:33:30-07:00",
        "created": "2018-07-27T15:43:55-07:00",
        "modified": "2018-07-29T15:43:55-07:00",
        "accessTimestamp": "2011-03-21T00:18:56-07:00",
        "accountName": "exampleaccount",
        "username": "exampleuser",
        "nickname": "exampleuser",
        "email": "example@exavault.mail",
        "homePath": "/",
        "role": "user",
        "timeZone": "America/Chicago"
      },
      "relationships": {
        "homeResource": {
          "data": {
            "type": "resource"
          }
        },
        "ownerAccount": {
          "data": {
            "type": "account"
          }
        }
      }
    }
  ]
}