Skip to main content
POST
email.contact-list.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
name
string
required

A name for the list, unique among your lists.

Required string length: 1 - 100
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$
description
string

What the list is for.

Required string length: 1 - 500
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$

Response

The result

name
string
required

The list's name: pass it wherever a list is asked for.

kind
enum<string>
required

list: contacts you add; segment: contacts matching a filter.

Available options:
list,
segment
description
string

What the list is for.

contactCount
number

How many contacts it holds.

createdAt
string

When it was created, ISO 8601.