Skip to contentSkip to navigationSkip to topbar
Rate this page:
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).


DELETE/v3/subusers/{subuser_name}

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

This endpoint allows you to delete a subuser.

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


Authentication

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

The username of the Subuser.

204401
Schema

No properties defined

Delete a subuser

delete-a-subuser 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 subuser_name = "Miss Christine Morgan";
_19
_19
const request = {
_19
url: `/v3/subusers/${subuser_name}`,
_19
method: 'DELETE',
_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: