代理リクエスト

サブユーザの代理でリクエストする

on-behalf-of ヘッダを利用すると、親アカウントが特定サブユーザの代理でリクエストを発行できるようになります。サブユーザの設定変更や管理を、サブユーザに切り替えることなく一括で行う場合に便利です。利用する際は、on-behalf-of ヘッダを追加しサブユーザのユーザ名を指定してください。

on-behalf-of ヘッダを付けてリクエストすると、サブユーザ自身がリクエストを行ったかのようにみえます。

使用する際には、親アカウントのAPIキーを指定する必要があります。

1
2
3
4
5
6

curl -X GET \
  'https://api.sendgrid.com/v3/stats?start_date=2021-01-01&end_date=2022-01-01&aggregated_by=month' \
  -H 'authorization: Bearer API Key' \
  -H 'on-behalf-of: subuser_username' \
  -H 'content-type: application/json'

mail.send APIでは on-behalf-of ヘッダは無視されます。