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

Get 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 Get Account State operation allows you to retrieve the state of a specific customer account. A customer account can be in one of five states: activated, deactivated, suspended, banned, or indeterminate*.

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.


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

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

Retrieve the state of the specified account.


Authentication

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

Twilio SendGrid account ID

200400401403404

OK

SchemaExample
stateenum<string>

The state of the account (e.g., activated, deactivated, suspended, banned, or indeterminate)

Possible values:
activateddeactivatedsuspendedbannedindeterminate

Get the state of a specific customer account

get-the-state-of-a-specific-customer-account page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

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


Rate this page: