Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Update Account State



API Overview

api-overview page anchor

The Twilio SendGrid Account Provisioning API provides a platform for Twilio SendGrid resellers to manage their customers. This API is for companies that have a formal reseller partnership with Twilio SendGrid.

You can access Twilio SendGrid sub-account functionality without becoming a reseller. If you require sub-account functionality, see the Twilio SendGrid Subusers feature, which is available with Pro and Premier plans(link takes you to an external page).

The Account Provisioning API account state operations allow you to update and retrieve the state of your customer accounts. Accounts can be in one of five states: activated, deactivated, suspended, banned, and indeterminate.

The Update Account State operation allows you to update the state of a specific customer account. A customer account can be updated to either of the following states: activated, deactivated.

The following table shows the actions available to an account based on its state.

ACCOUNT STATELOGINSEND MAILSUBUSERS REMOVEDDEDICATED IPS REMOVEDAPI KEYS DEACTIVATED
Activatedyesyesnonono
Suspendedyesnononono
Deactivatednonononoyes
Bannednonoyesyesyes

*If you find an account in the indeterminate state, please contact Twilio SendGrid support(link takes you to an external page) for help troubleshooting.


PUT/v3/partners/accounts/{accountID}/state

Base url: https://api.sendgrid.com

Update the state of the specified account.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
accountIDstringrequired

Twilio SendGrid account ID

SchemaExample
stateenum<string>required

The state of the account (e.g., activated, deactivated)

Possible values:
activateddeactivated
204400401403

State successfully updated

Update a customer account's state

update-a-customer-accounts-state page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const accountID = "ZGkrHSypTsudrGkmdpJJ";
_22
const data = {
_22
"state": "activated"
_22
};
_22
_22
const request = {
_22
url: `/v3/partners/accounts/${accountID}/state`,
_22
method: 'PUT',
_22
body: data
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: