API

Een contact aanmaken

Slaat één adres op in het adresboek van de workspace. Het adres is de identiteit, dus er is geen id om te kiezen en er staat er ook geen in het antwoord. Het wordt getrimd en omgezet naar kleine letters voordat het wordt opgeslagen, en het contact wordt opgeslagen met `source` op `manual`. Het nieuwe contact komt bij het wegschrijven in de ingebouwde standaard-audience terecht, plus in alles wat in `audienceIds` wordt genoemd.

POSTapi.openemail.uk/contacts

Voert de echte aanroep uit op je workspace, met je eigen sleutel.

POST /contacts

Slaat één adres op in het adresboek van de workspace. Het adres is de identiteit, dus er is geen id om te kiezen en er staat er ook geen in het antwoord. Het wordt getrimd en omgezet naar kleine letters voordat het wordt opgeslagen, en het contact wordt opgeslagen met source op manual. Het nieuwe contact komt bij het wegschrijven in de ingebouwde standaard-audience terecht, plus in alles wat in audienceIds wordt genoemd.

Voorbeeld

Vereist contacts:write. audienceIds meesturen vereist daarnaast audiences:write.

curl

curl -X POST "$OE/contacts" -H "$AUTH" -H 'content-type: application/json' -d '{  "email": "[email protected]",  "name": "Grace Hopper",  "notes": "Met at the compiler workshop"}'

Antwoord

{  "object": "contact",  "email": "[email protected]",  "name": "Grace Hopper",  "source": "manual",  "notes": "Met at the compiler workshop",  "lastSeenAt": null,  "createdAt": "2026-09-18T09:00:00.000Z",  "updatedAt": "2026-09-18T09:00:00.000Z",  "audiences": [    { "id": "aud_9f2c4b7e1a0d63d84c5f2e7b", "name": "All contacts", "builtin": "default" }  ]}

Een adres dat al in het adresboek staat levert een 409 contact_exists op in plaats van een samenvoeging, zodat een nieuwe poging niet stilletjes een naam overschrijft die iemand in de app heeft bewerkt. Lees de rij en doe in plaats daarvan een PATCH.

lastSeenAt blijft null totdat er vanuit de composer in de app post naar het adres gaat. source en lastSeenAt zijn van de server en worden niet in de body geaccepteerd.

Een audience-id in audienceIds die niet in deze workspace bestaat levert een 404 op en er wordt niets weggeschreven.