Skip to content Skip to navigation Skip to topbar

Enable/Disable website access for a Subuser, while still preserving email send functionality

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}/website_access

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

Enable/Disable website access for a Subuser, while still preserving email send functionality.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

subuser_namestringrequired

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

disabledbooleanOptional

Whether or not to disable website access to the Subuser. true means disabled, false means enabled.

Responses

204

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

Enable/Disable website access for a subuser, while still preserving email send functionality

Node.js

Python

Java

PHP

Ruby

curl


_22const client = require('@sendgrid/client');
_22client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22const subuser_name = "some_one";
_22const data = {
_22  "disabled": true
_22};
_22
_22const request = {
_22  url: `/v3/subusers/${subuser_name}/website_access`,
_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  });