On this page

Delete a subuser

API Overview

For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console.

Operation overview

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

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

subuser_namestringrequired

The username of the Subuser.

Responses

204401

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

Delete a subuser

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const subuser_name = "Miss Christine Morgan";
5
6const request = {
7  url: `/v3/subusers/${subuser_name}`,
8  method: 'DELETE',
9  
10}
11
12client.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  });