Skip to content Skip to navigation Skip to topbar

On this page

Enable/disable 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

PATCH/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 enable or disable a subuser.

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.

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

disabledbooleanOptional

Whether or not this subuser is disabled. true means disabled, false means enabled.

Responses

204400401500

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Enable/disable a subuser

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const subuser_name = "Miss Christine Morgan";
5const data = {
6  "disabled": false
7};
8
9const request = {
10  url: `/v3/subusers/${subuser_name}`,
11  method: 'PATCH',
12  body: data
13}
14
15client.request(request)
16  .then(([response, body]) => {
17    console.log(response.statusCode);
18    console.log(response.body);
19  })
20  .catch(error => {
21    console.error(error);
22  });