Skip to content Skip to navigation Skip to topbar

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

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

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

Node.js

Python

C#

Java

Go

PHP

Ruby

curl


_22const client = require('@sendgrid/client');
_22client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22const subuser_name = "Miss Christine Morgan";
_22const data = {
_22  "disabled": false
_22};
_22
_22const request = {
_22  url: `/v3/subusers/${subuser_name}`,
_22  method: 'PATCH',
_22  body: data
_22}
_22
_22client.request(request)
_22  .then(([response, body]) => {
_22    console.log(response.statusCode);
_22    console.log(response.body);
_22  })
_22  .catch(error => {
_22    console.error(error);
_22  });