Menu

Expand
Rate this page:

Account Provisioning API: Offering Operations

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.

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

Update Account Offerings

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

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Request Body

object
offerings
array[object]

List of offerings to assign to account.

required
name
string

Name of the offering

required
type
string

Defines the type of offering (e.g., package or addon).

Allowed Values: package, addon
required
quantity
integer

Quantity of the specified addon to be added. If offering type is package, quantity must be 1.

format: int64

Path Parameters

accountID
string

Twilio SendGrid account ID

default: None
required

Responses

object
offerings
array[object]
name
string

Name of the offering

required
type
string

Defines the type of offering (e.g., package or addon).

Allowed Values: package, addon
required
quantity
integer

Quantity of the specified addon to be added. If offering type is package, quantity must be 1.

format: int64
object
errors
array[object]
required
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
object
errors
array[object]
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
object
errors
array[object]
message
string

The message representing the error from the API.

required
field
string

The field associated with the error.

required
error_id
string

ID representing the error as a unique nubmer.

required
Loading Code Sample...
        
        

        Update customer account offerings

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif