Skip to content Skip to navigation Skip to topbar

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

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

Node.js

Python

Java

PHP

Ruby

curl


_19const client = require('@sendgrid/client');
_19client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19const subuser_name = "Miss Christine Morgan";
_19
_19const request = {
_19  url: `/v3/subusers/${subuser_name}`,
_19  method: 'DELETE',
_19  
_19}
_19
_19client.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  });