How to Suspend/Deactivate Subuser Accounts

Objective

Suspending/Deactivating sub-users/sub-accounts in the SendGrid Console or via API.  When the customer has suspended the user on their end, and the sub-account itself has not been deactivated or suspended within the SendGrid platform.  Note, disabling the user on their end, that is acceptable, but we also want the unused account to also be deleted. 
  

 

Product

Twilio SendGrid

 

User Account Permission/Role(s) Required 

Parent Account Holders and Teammate Users with Admin or Subuser Management Permission

 

Procedure 

To temporarily disable (deactivate) a subuser:
 

  1. Log in to the SendGrid app (https://app.sendgrid.com).
  2. Navigate to Settings > Subuser Management.
  3. Locate and click the subuser account you want to disable.
  4. On the subuser’s account details page, click Disable Account.

To permanently delete a subuser:
 

  1. Follow steps 1–4 above.
  2. On the subuser’s account details page, click Delete.
  3. Confirm the deletion in the pop-up window.

Note:
 

  • Disabling a subuser is reversible (you can re-enable later).
  • Deleting a subuser is permanent and cannot be undone.

Via the API

If you are a SendGrid reseller or have access to the Account Provisioning API, you can update the account state:
 

To deactivate a sub-account:
 

  • Use the following endpoint:
    PUT /v3/partners/accounts/{accountID}/state
  • Set the body to:
    { "state": "deactivated" }

Example (Node.js):
 

const client = require("@sendgrid/client");
client.setApiKey(process.env.SENDGRID_API_KEY);

const accountID = "your_subaccount_id";
const data = { state: "deactivated" };

const request = {
  url: `/v3/partners/accounts/${accountID}/state`,
  method: "PUT",
  body: data,
};

client
  .request(request)
  .then(([response, body]) => {
    console.log(response.statusCode);
    console.log(response.body);
  })
  .catch((error) => {
    console.error(error);
  });
  • You can also set "state": "activated" to re-enable the account.

Additional Notes

  • Deactivated subusers cannot send mail, but can still log in directly.
  • Deleted subusers lose all SendGrid access immediately.
  • If you do not see these options, you may need admin privileges or a specific plan (Pro or Premier).

 

Additional Information 

 

Have more questions? Submit a request