List
Preview
GET
https://api.senditly.ai/v1/mailing_lists
List mailing lists
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Query
limit
integer
optional
A limit on the number of items to return. Defaults to 10. The value must be between 1 and 100.
startingAfter
string
optional
A cursor to start the list from. Defaults to the first item.
endingBefore
string
optional
A cursor to end the list at. Defaults to the last item.
Response
items
array
required
hasMore
boolean
required
Whether there are more items to fetch.
cursor
string
optional
A cursor to start the next list from.
Count
Preview
GET
https://api.senditly.ai/v1/mailing_lists/count
Count mailing lists
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Query
after
string
optional
A cursor to start the count from.
before
string
optional
A cursor to end the count at.
Response
count
integer
required
The total number of items.
Create
Preview
POST
https://api.senditly.ai/v1/mailing_lists
Create a mailing list
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Request
id
string
optional
The id of the mailing list. If not provided, a new id will be generated. This should be an unique identifier for the mailing list.
name
string
required
The name of the mailing list.
description
string
required
The description of the mailing list.
policy
enum
required
The policy of the mailing list.
active
boolean
optional
Whether the mailing list is active.
Response
id
string
required
The id of the mailing list.
name
string
required
The name of the mailing list.
description
string
required
The description of the mailing list.
policy
enum
required
The policy of the mailing list.
status
enum
required
The status of the mailing list.
createdAt
string
required
A date string in ISO 8601 format when the mailing list was created.
updatedAt
string
required
A date string in ISO 8601 format when the mailing list was last updated.
Retrieve
Preview
GET
https://api.senditly.ai/v1/mailing_lists/:id
Retrieve a mailing list
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The id of the mailing list.
Response
id
string
required
The id of the mailing list.
name
string
required
The name of the mailing list.
description
string
required
The description of the mailing list.
policy
enum
required
The policy of the mailing list.
status
enum
required
The status of the mailing list.
createdAt
string
required
A date string in ISO 8601 format when the mailing list was created.
updatedAt
string
required
A date string in ISO 8601 format when the mailing list was last updated.
Update
Preview
POST
https://api.senditly.ai/v1/mailing_lists/:id
Update a mailing list
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The id of the mailing list.
Request
name
string
optional
The name of the mailing list.
description
string
optional
The description of the mailing list.
policy
enum
optional
The policy of the mailing list.
active
boolean
optional
Whether the mailing list is active.
Response
id
string
required
The id of the mailing list.
name
string
required
The name of the mailing list.
description
string
required
The description of the mailing list.
policy
enum
required
The policy of the mailing list.
status
enum
required
The status of the mailing list.
createdAt
string
required
A date string in ISO 8601 format when the mailing list was created.
updatedAt
string
required
A date string in ISO 8601 format when the mailing list was last updated.
Delete
Preview
DELETE
https://api.senditly.ai/v1/mailing_lists/:id
Delete a mailing list
This API is in preview. It may be changed in the future.
Headers
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Parameters
id
string
required
The id of the mailing list.
Response
startedAt
string
required
A date string in ISO 8601 format when the mailing list deletion was started.
Senditly© 2025 Unbounded Pioneering Inc.
Privacy PolicyTerms of ServiceAnti-Spam PolicyData Processing AgreementInformation Security PolicyService Level Agreement