FlaresendDocs
Contacts

Import contacts

Create or update up to 5,000 contacts in one request.

POST/v1/contacts/importAPI key

The body is a JSON array of contacts. Each one is upserted by email with the same rules as Create a contact: new addresses are created, existing ones get the fields you send, and a missing unsubscribed never re-subscribes anyone.

If the same address appears more than once in the array, the last entry wins.

The whole array is validated first. One invalid entry fails the request and nothing is imported.

Imported contacts are not added to any audience. Use Add contacts to an audience with the IDs afterwards.

Body

[]Contact[]required

Between 1 and 5,000 contacts.

Show contact properties
emailstringrequired

The address. Stored lowercased.

firstNamestring | null

Up to 200 characters.

lastNamestring | null

Up to 200 characters.

Left out: new contacts are subscribed and existing ones keep their status.

dataobject | null

Extra values for broadcast templates.

Response

creatednumber

How many addresses were new to the project.

updatednumber

How many addresses already existed and were updated.

Errors

StatusCodeWhen
400missing_bodyThe request has no body.
400invalid_bodyThe body is not an array, is empty, has more than 5,000 entries, or an entry is invalid. param points at it, for example 12.email.