Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Update Account Offerings



API Overview

api-overview page anchor

The Twilio SendGrid Account Provisioning API provides a platform for Twilio SendGrid resellers to manage their customers. This API is for companies that have a formal reseller partnership with Twilio SendGrid.

You can access Twilio SendGrid sub-account functionality without becoming a reseller. If you require sub-account functionality, see the Twilio SendGrid Subusers feature, which is available with Pro and Premier plans(link takes you to an external page).

The Account Provisioning API offering operations allow you to update and list Twilio SendGrid features or offerings available for your customer accounts.

The Update Account Offerings operation allows you to add or remove offerings from a specific customer account. Offerings are Twilio SendGrid features or offerings such as a dedicated IP address or Marketing Campaigns package.

The update is an idempotent PUT operation and each request overwrites existing offerings on the customer account. For this reason, you should include any permissions you want the account to retain with each request, omitting only those you wish to remove from the account. Upgrades and downgrades are available immediately after account provisioning.

To retrieve a list of all the offerings you may assign to a customer account, use the List Offerings operation.


PUT/v3/partners/accounts/{accountID}/offerings

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

Changes a package offering for the specified account. Please note that an account can have only one package offering. Also associates one or more add-on offerings such as Marketing Campaigns, Dedicated IP Addresses, and Expert Services to the specified account.


Authentication

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

Twilio SendGrid account ID

SchemaExample
offeringsarray[object]required

List of offerings to assign to account.

200400401403

OK

Schema
offeringsarray[object]

Update customer account offerings

update-customer-account-offerings page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_27
const client = require('@sendgrid/client');
_27
client.setApiKey(process.env.SENDGRID_API_KEY);
_27
_27
const accountID = "ZGkrHSypTsudrGkmdpJJ";
_27
const data = {
_27
"offerings": [
_27
{
_27
"name": "Miss Christine Morgan",
_27
"type": "package"
_27
}
_27
]
_27
};
_27
_27
const request = {
_27
url: `/v3/partners/accounts/${accountID}/offerings`,
_27
method: 'PUT',
_27
body: data
_27
}
_27
_27
client.request(request)
_27
.then(([response, body]) => {
_27
console.log(response.statusCode);
_27
console.log(response.body);
_27
})
_27
.catch(error => {
_27
console.error(error);
_27
});


Rate this page: