API

Einen Kontakt anlegen

Speichert eine Adresse im Adressbuch des Workspace. Die Adresse ist die Identität; es gibt daher keine id zu wählen und auch keine in der Antwort. Sie wird vor dem Speichern getrimmt und in Kleinbuchstaben umgewandelt, und der Kontakt wird mit `source` auf `manual` gespeichert. Der neue Kontakt kommt beim Schreiben in die eingebaute Standard-Audience sowie in alles, was in `audienceIds` genannt ist.

POSTapi.openemail.uk/contacts

Führt den echten Aufruf gegen Ihren Workspace aus, mit Ihrem eigenen Schlüssel.

POST /contacts

Speichert eine Adresse im Adressbuch des Workspace. Die Adresse ist die Identität; es gibt daher keine id zu wählen und auch keine in der Antwort. Sie wird vor dem Speichern getrimmt und in Kleinbuchstaben umgewandelt, und der Kontakt wird mit source auf manual gespeichert. Der neue Kontakt kommt beim Schreiben in die eingebaute Standard-Audience sowie in alles, was in audienceIds genannt ist.

Beispiel

Erfordert contacts:write. Wer audienceIds mitsendet, benötigt zusätzlich 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"}'

Antwort

{  "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" }  ]}

Eine Adresse, die bereits im Adressbuch steht, ergibt ein 409 contact_exists statt einer Zusammenführung; ein erneuter Versuch kann so keinen Namen stillschweigend überschreiben, den jemand in der App bearbeitet hat. Lesen Sie stattdessen die Zeile und ändern Sie sie per PATCH.

lastSeenAt bleibt null, bis aus dem Composer der App Mail an die Adresse geht. source und lastSeenAt gehören dem Server und werden im Body nicht akzeptiert.

Eine Audience-id in audienceIds, die es in diesem Workspace nicht gibt, ergibt ein 404, und es wird nichts geschrieben.