Menu

Expand
Rate this page:

Account Provisioning API: Account State Operations

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.

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.

Update Account State

The Account Provisioning API is in private beta and accessible by invitation only at this time.

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 STATE LOGIN SEND MAIL SUBUSERS REMOVED DEDICATED IPS REMOVED API KEYS DEACTIVATED
Activated yes yes no no no
Suspended yes no no no no
Deactivated no no no no yes
Banned no no yes yes yes

*If you find an account in the indeterminate state, please contact Twilio SendGrid support for help troubleshooting.

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

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

Update the state of the specified account.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Request Body

object
state
string

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

Allowed Values: activated, deactivated
required
{
  "state": "activated"
}

Path Parameters

accountID
string

Twilio SendGrid account ID

default: None
required

Responses

No response body.
object
errors
array[object]
required
message
string

The message representing the error from the API.

field
string

The field associated with the error.

error_id
string

ID representing the error as a unique nubmer.

object
errors
array[object]
message
string

The message representing the error from the API.

field
string

The field associated with the error.

error_id
string

ID representing the error as a unique nubmer.

object
errors
array[object]
message
string

The message representing the error from the API.

field
string

The field associated with the error.

error_id
string

ID representing the error as a unique nubmer.

        
        
        
        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif