Account Limits

サブユーザが一定期間内に送信できるメールの量を制御します。

Retrieve

指定したサブユーザのAccount Limitsを取得します。このAPIの応答が空の場合、制限がないことを意味します。

URI引数 必須 条件 説明
task Yes retrieveを指定します 制限の取得
user Yes サブユーザは親アカウント配下に登録されている必要があります 制限のあるサブユーザ一覧を取得できます
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.limit.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=retrieve

Response

1
2
3
4
5
{
  "credit": "200",
  "credit_remain": "200",
  "last_reset": "2014-11-21"
}

Call

POST https://api.sendgrid.com/apiv2/customer.limit.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=retrieve

Response

1
2
3
4
5
<credits>
   <credit>200</credit>
   <credit_remain>200</credit_remain>
   <last_reset>2014-11-21</last_reset>
</credits>

No Limit

サブユーザの制限を解除します。

URI引数 必須 条件 説明
task Yes noneを指定します 制限の解除
user Yes サブユーザは親アカウント配下に登録されている必要があります クレジット制限を解除するサブユーザ
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.limit.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=none

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.limit.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=none

Response

1
2
3
<result>
   <message>success</message>
</result>

Recurring Reset

サブユーザが送信可能なメールの量(クレジット)を定期的に指定した値にリセットすることができます。日次、週次、月次で指定することができます。

URI引数 必須 条件 説明
task Yes recurringを指定します 定期的にクレジットをリセットします
user Yes サブユーザは親アカウント配下に登録されている必要があります 定期的にリセットを適用するサブユーザ
credits Yes 正の整数 リセットするクレジット数
period Yes daily, weekly, monthlyのいずれか リセットの頻度
startdate No YYY-mm-ddフォーマットの日付 リセットの開始日
enddate No YYY-mm-ddフォーマットの日付 リセットの停止日。この日付の後、クレジットは追加されませんが、クレジットを消費することは可能です。
initial_credits No 正の整数 リセットのデフォルト値。指定されなかった場合、creditsの値が適用されます。特定のサブユーザのクレジットデフォルト値を変更する場合に利用可能です。
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.limit.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=recurring&credits=200&period=daily

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.limit.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=recurring&credits=200&period=daily

Response

1
2
3
<result>
   <message>success</message>
</result>

Total Credits

サブユーザのクレジットを指定した量に変更します。クレジットはメール送信可能な量です。

URI引数 必須 条件 説明
task Yes totalを指定します サブユーザのクレジットを指定した量に変更します
user Yes サブユーザは親アカウント配下に登録されている必要があります クレジットを変更するサブユーザ
credits Yes 正の整数 クレジットの値
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.limit.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=total&credits=200

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.limit.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=total&credits=200

Response

1
2
3
<result>
   <message>success</message>
</result>

Increment Credits

サブユーザのクレジットを指定した量増加させます。

URI引数 必須 条件 説明
task Yes incrementを指定します サブユーザのクレジットを指定した量に増加させます
user Yes サブユーザは親アカウント配下に登録されている必要があります クレジットを増加するサブユーザ
credits Yes 正の整数 クレジットの増加量
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.limit.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=increment&credits=20

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.limit.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=increment&credits=20

Response

1
2
3
<result>
   <message>success</message>
</result>

Decrement Credits

サブユーザのクレジットを指定した量減少させます。

URI引数 必須 条件 説明
task Yes decrementを指定します サブユーザのクレジットを指定した量に減少させます
user Yes サブユーザは親アカウント配下に登録されている必要があります クレジットを減少するサブユーザ
credits Yes 正の整数 クレジットの減少量
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/apiv2/customer.limit.json
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=decrement&credits=200

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/apiv2/customer.limit.xml
POST Data api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username&task=decrement&credits=200

Response

1
2
3
<result>
   <message>success</message>
</result>