Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Delete a subuser

API Overview

api-overview page anchor

For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console(link takes you to an external page).

Operation overview

operation-overview page anchor

DELETE/v3/subusers/{subuser_name}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to delete a subuser.

This is a permanent action. Once deleted, a subuser cannot be retrieved.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
subuser_namestring
required

The username of the Subuser.

Responses

responses page anchor
204401
No response body.
Delete a subuserLink to code sample: Delete a subuser
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const subuser_name = "subuser_name";

5


6
const request = {

7
  url: `/v3/subusers/${subuser_name}`,

8
  method: "DELETE",

9
};

10


11
client

12
  .request(request)

13
  .then(([response, body]) => {

14
    console.log(response.statusCode);

15
    console.log(response.body);

16
  })

17
  .catch((error) => {

18
    console.error(error);

19
  });