Skip to contentSkip to navigationSkip to topbar
Page tools
Useful for sharing or LLM
Accelerate development with AI

On this page
Looking for more inspiration?Visit the

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 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.

Changing an account's package removes any offerings the new package does not allow, even if you include them in the request. Dedicated IP add-ons are removed only when the account's current package allows them and the new package doesn't. When they're removed, the account's dedicated IPs are released immediately and can't be returned to the account.

This operation doesn't manage dedicated IP addresses. It ignores IP add-ons in the request, and omitting them doesn't remove them. To add or remove IPs, use the IP Provisioning API instead.

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 (for global users and subusers)

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

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
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
accountIDstring
required

Twilio SendGrid account ID

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
offeringsarray[Offering]
required

List of offerings to assign to account.

200400401403500502503504

OK

Schema
Property nameTypeRequiredDescriptionChild properties
offeringsarray[Offering]

Optional

Update customer account offeringsLink to code sample: Update customer account offerings
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const accountID = "accountID";
5
const data = {
6
offerings: [
7
{
8
name: "org.ei.free.v1",
9
type: "package",
10
quantity: 1,
11
},
12
],
13
};
14
15
const request = {
16
url: `/v3/partners/accounts/${accountID}/offerings`,
17
method: "PUT",
18
body: data,
19
};
20
21
client
22
.request(request)
23
.then(([response, body]) => {
24
console.log(response.statusCode);
25
console.log(response.body);
26
})
27
.catch((error) => {
28
console.error(error);
29
});