ドキュメント本文へスキップ
API

連絡先を作成する

ワークスペースのアドレス帳にアドレスを 1 件保存します。アドレスが識別子そのものなので、選ぶべき id はなく、レスポンスにも id はありません。アドレスはトリムして小文字化してから保存され、連絡先は `source` を `manual` として保存されます。新しい連絡先は書き込みと同時に組み込みのデフォルトオーディエンスに加わり、さらに `audienceIds` で指定したものにも加わります。

POSTapi.openemail.uk/contacts

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

POST /contacts

ワークスペースのアドレス帳にアドレスを 1 件保存します。アドレスが識別子そのものなので、選ぶべき id はなく、レスポンスにも id はありません。アドレスはトリムして小文字化してから保存され、連絡先は sourcemanual として保存されます。新しい連絡先は書き込みと同時に組み込みのデフォルトオーディエンスに加わり、さらに audienceIds で指定したものにも加わります。

contacts:write が必要です。audienceIds を送る場合は 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"}'
レスポンス
{  "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" }  ]}

すでにアドレス帳にあるアドレスは、マージではなく 409 contact_exists になります。再試行が、誰かがアプリで編集した名前を黙って上書きしてしまわないようにするためです。行を読み取って PATCH してください。

lastSeenAt は、アプリのコンポーザーからそのアドレス宛にメールが送られるまで null のままです。sourcelastSeenAt はサーバーが管理するもので、ボディでは受け付けられません。

audienceIds にこのワークスペースに存在しないオーディエンス id が含まれていると 404 になり、何も書き込まれません。