Create a list - Lists - API Reference

POST

https://api.us.nylas.com/v3/lists

Creates a list for your application. Lists are typed collections of values (domains, TLDs, or email addresses) that can be referenced by rules using the in_list condition operator.

The list's type is set at creation and cannot be changed.

Works with an API key or an IAM API key with the lists.create permission.

Request body

name*string

Example: "Blocked domains"

minLength: 1maxLength: 256

descriptionstring

Example: "Domains we've identified as sending unwanted mail."

type*string

The kind of values the list holds. Immutable after creation.

domaintldaddress

Example: "domain"

Responses

request_idstring

ID of the request.

Example: "5fa64c92-e840-4357-86b9-2aa364d35b88"

dataobject

curl -X POST "https://api.us.nylas.com/v3/lists" \ -H "Authorization: Bearer <NYLAS_API_KEY>" \ -H "Content-Type: application/json" \ -d '{ "name": "Blocked domains", "description": "Domains we have identified as sending unwanted mail.", "type": "domain" }'