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

連絡先の写真を設定する

連絡先に表示する写真をアップロードし、既存の写真を置き換えます。ボディは JSON ではなく画像そのもので、種類を `Content-Type` に指定します。`image/png`、`image/jpeg`、`image/webp`、`image/gif` のいずれかで、最大 5 MB です。512 ピクセルの正方形に収めて WebP として保存し、アニメーション画像は最初のフレームだけを残します。

PUTapi.openemail.uk/contacts/{email}/photo

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

PUT /contacts/{email}/photo

連絡先に表示する写真をアップロードし、既存の写真を置き換えます。ボディは JSON ではなく画像そのもので、種類を Content-Type に指定します。image/pngimage/jpegimage/webpimage/gif のいずれかで、最大 5 MB です。512 ピクセルの正方形に収めて WebP として保存し、アニメーション画像は最初のフレームだけを残します。

contacts:write が必要です。アドレスは保存済みの連絡先である必要があるので、先に PUT /contacts/{email} で保存してください。

curl
curl -X PUT "$OE/contacts/grace%40example.com/photo" -H "$AUTH" -H 'content-type: image/jpeg' --data-binary @grace.jpg
レスポンス
{  "object": "contact",  "email": "[email protected]",  "name": "Grace Hopper",  "source": "manual",  "notes": null,  "photoUrl": "https://cdn-prod.openemail.uk/contacts/photos/5b0e2c7a-91d4-4f3e-8a26-c4f1d9e07b3a.webp",  "lastSeenAt": null,  "createdAt": "2026-09-18T09:00:00.000Z",  "updatedAt": "2026-09-23T10:20:00.000Z",  "audiences": [    { "id": "aud_9f2c4b7e1a0d63d84c5f2e7b", "name": "All contacts", "builtin": "default" }  ]}

保存済みの連絡先でないアドレスは 404 contact_not_found です。受け付ける種類の画像でないボディ、5 MB を超えるボディ、読み取れないボディは 422 invalid_image です。

画像サービスが混み合っていると 503 image_busy を返します。これは安全に再試行できます。アップロードのたびに新しい photoUrl になるので、キャッシュされた古い写真が新しい写真の代わりに表示されることはありません。