Reference, v1

Recipient lists

Calls are made to https://api.footer365.net with an API key as a bearer token. This page is generated from the API's own description, which you can download.

PUT /v1/recipient-lists/{id}/entries

Replaces a list's entries

Replaces everything the list holds with the addresses and domains sent, as importing a file in Replace mode does on the Recipient lists page. An address is kept only as a one-way code and cannot be read back, so no call returns one. Values that are neither an address nor a domain, and wildcards, are left out and counted in notUsed. A list holds at most 100,000 entries; more than that is refused with list_too_large and nothing is changed. A large list is written in the background, and queued says so. Needs lists.write, and a key made by an administrator limited to part of the organisation is refused with list_organisation_wide, because a list belongs to the whole organisation. Fails with recipient_list_not_found for a list that is not yours.

Parameter	In	Type	About it
`id`	path	string (uuid)	The list's id.

Takes ListEntries. Answers 200 with ListEntriesResult.

Types

`ListEntries`

Property	Type	About it
`addresses`	array of string, or null	Whole email addresses. Each is kept only as a one-way code.
`domains`	array of string, or null	Domains, written as example.com. A domain covers its subdomains.

`ListEntriesResult`

Property	Type	About it
`used`	integer	How many distinct entries the list now holds, or will hold when the background write finishes.
`addresses`	integer	How many of them are addresses.
`domains`	integer	How many of them are domains.
`notUsed`	integer	How many values were left out because they are not an address or a domain, or repeat one already sent.
`queued`	boolean	True when the list is being written in the background and still holds its old entries for a short while.

Errors are written the same way for every call; see Errors. Answers may gain fields within a version, so ignore any you do not recognise.