PRprismic
Email Lists

Update an email group

Add or remove emails from an email list that can be used to send and share files with groups.

Notes

This call will replace your current email list in its entirety. If you want to keep any existing emails on the list, be sure to submit the call with any current emails you want to keep on the list.

patch/email-lists/{id}

Request

Path parameters

idinteger required

ID of the email list to update.

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

Name of the email list.

emailsstring[]

Email addresses that replace existing list.

Example request

{
  "name": "My friends list",
  "emails": [
    "yuk@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"
          }
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.