Target lists

Recipient management

List Lists

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

get

/api/lists

HTTPcURLJavaScriptPython

GET /api/lists HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": 1,
    "name": "text",
    "target_count": 1
  }
]

Create List

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

namestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/lists

HTTPcURLJavaScriptPython

POST /api/lists HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": 1,
  "name": "text",
  "target_count": 1
}

Rename List

put

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

list_idintegerRequired

Body

application/json

namestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/api/lists/{list_id}

HTTPcURLJavaScriptPython

PUT /api/lists/{list_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": 1,
  "name": "text",
  "target_count": 1
}

Delete List

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

list_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/api/lists/{list_id}

HTTPcURLJavaScriptPython

DELETE /api/lists/{list_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

List Targets

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

list_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/lists/{list_id}/targets

HTTPcURLJavaScriptPython

GET /api/lists/{list_id}/targets HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Add Targets

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

list_idintegerRequired

Bodyobject · TargetCreate[]

application/json

first_nameany ofOptional

stringOptional

or

nullOptional

last_nameany ofOptional

stringOptional

or

nullOptional

emailstring · emailRequired

extra_fieldany ofOptional

stringOptional

or

nullOptional

extraany ofOptional

objectOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/lists/{list_id}/targets

HTTPcURLJavaScriptPython

POST /api/lists/{list_id}/targets HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 99

[
  {
    "first_name": "text",
    "last_name": "text",
    "email": "[e-mail]",
    "extra_field": "text",
    "extra": {}
  }
]

No content

Delete Target

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

target_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/api/targets/{target_id}

HTTPcURLJavaScriptPython

DELETE /api/targets/{target_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Duplicate Target List

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

list_idintegerRequired

Body

application/json

namestringRequired

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/api/lists/{list_id}/duplicate

HTTPcURLJavaScriptPython

POST /api/lists/{list_id}/duplicate HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": 1,
  "name": "text",
  "target_count": 1
}

Search Lists By Email

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Query parameters

emailstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/lists/search-by-email

HTTPcURLJavaScriptPython

GET /api/lists/search-by-email?email=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content