# Update Account Offerings ## API Overview 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](https://sendgrid.com/pricing/). 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](/docs/sendgrid/api-reference/account-provisioning-api-offering-operations/list-offerings) operation. ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/partners/accounts/{accountID}/offerings","method":"put","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"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. ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}}] ``` ### Path parameters ```json [{"name":"accountID","in":"path","description":"Twilio SendGrid account ID","schema":{"type":"string"},"required":true,"example":"sg2a2bcd3ef4ab5c67d8efab91c01de2fa","refName":"#/components/parameters/AccountProvisioningAccountId","modelName":"__components_parameters_AccountProvisioningAccountId"}] ``` ### Request body ```json {"schema":{"title":"OfferingsToAdd","type":"object","required":["offerings"],"properties":{"offerings":{"type":"array","description":"List of offerings to assign to account.","items":{"title":"Offering","type":"object","description":"An offering is a package (email infrastructure) or add-on (marketing campaigns, dedicated IP addresses, EASE) that an account can acquire. Each offering has a list of entitlements that indicate the benefits the account receives from the acquisition.","required":["name","type"],"example":{"name":"org.ei.free.v1","type":"package","quantity":1},"refName":"AccountProvisioningOfferingV1","modelName":"AccountProvisioningOfferingV1","properties":{"name":{"type":"string","description":"Name of the offering"},"type":{"type":"string","description":"Defines the type of offering (e.g., package or addon).","enum":["package","addon"],"refName":"Type","modelName":"Type"},"quantity":{"type":"integer","format":"int64","description":"Quantity of the specified addon to be added. If offering type is `package`, quantity must be 1."}}}}}},"example":{"offerings":[{"name":"org.ei.free.v1","type":"package","quantity":1}]},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"200","schema":{"description":"OK","content":{"application/json":{"schema":{"title":"OfferingList","type":"object","refName":"AccountProvisioningOfferingList","modelName":"AccountProvisioningOfferingList","properties":{"offerings":{"type":"array","items":{"title":"Offering","type":"object","description":"An offering is a package (email infrastructure) or add-on (marketing campaigns, dedicated IP addresses, EASE) that an account can acquire. Each offering has a list of entitlements that indicate the benefits the account receives from the acquisition.","required":["name","type"],"example":{"name":"org.ei.free.v1","type":"package","quantity":1},"refName":"AccountProvisioningOfferingV1","modelName":"AccountProvisioningOfferingV1","properties":{"name":{"type":"string","description":"Name of the offering"},"type":{"type":"string","description":"Defines the type of offering (e.g., package or addon).","enum":["package","addon"],"refName":"Type","modelName":"Type"},"quantity":{"type":"integer","format":"int64","description":"Quantity of the specified addon to be added. If offering type is `package`, quantity must be 1."}}}}}}}}}},{"responseCode":"400","schema":{"description":"The request was formatted incorrectly or missing required parameters.","content":{"application/json":{"schema":{"title":"Bad Request","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","required":["message","field","error_id"],"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"message":{"type":"string","description":"The message representing the error from the API."},"field":{"type":"string","description":"The field associated with the error."},"error_id":{"type":"string","description":"ID representing the error as a unique nubmer."}}}}}},"example":{"errors":[{"message":"Field must be a valid email","field":"email","error_id":"10-40002"},{"message":"Field must be formatted using the E.164 standard consisting of [+] [country code] [subscriber number including area code] and can have a maximum of fifteen digits.","field":"phone","error_id":"10-40010"},{"message":"Field must be a valid URL","field":"company_website","error_id":"10-40008"}]}}},"refName":"#/components/responses/AccountProvisioningErrorResponse400","modelName":"__components_responses_AccountProvisioningErrorResponse400"}},{"responseCode":"401","schema":{"description":"Request lacks valid authentication credentials","content":{"application/json":{"schema":{"title":"Unauthorized","type":"object","properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","required":["message","field","error_id"],"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"message":{"type":"string","description":"The message representing the error from the API."},"field":{"type":"string","description":"The field associated with the error."},"error_id":{"type":"string","description":"ID representing the error as a unique nubmer."}}}}}},"example":{"errors":[{"message":"Failed to authenticate user","field":"","error_id":"10-40100"}]}}},"refName":"#/components/responses/AccountProvisioningErrorResponse401","modelName":"__components_responses_AccountProvisioningErrorResponse401"}},{"responseCode":"403","schema":{"description":"Not authorized to make the request","content":{"application/json":{"schema":{"title":"Forbidden","type":"object","properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","required":["message","field","error_id"],"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"message":{"type":"string","description":"The message representing the error from the API."},"field":{"type":"string","description":"The field associated with the error."},"error_id":{"type":"string","description":"ID representing the error as a unique nubmer."}}}}}},"example":{"errors":[{"message":"The authenticated user is not authorized to perfrom this request","field":"","error_id":"10-40300"}]}}},"refName":"#/components/responses/AccountProvisioningErrorResponse403","modelName":"__components_responses_AccountProvisioningErrorResponse403"}},{"responseCode":"500","schema":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"InternalServerError","type":"object","properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","required":["message","field","error_id"],"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"message":{"type":"string","description":"The message representing the error from the API."},"field":{"type":"string","description":"The field associated with the error."},"error_id":{"type":"string","description":"ID representing the error as a unique nubmer."}}}}}},"example":{"errors":[{"message":"Something went wrong","field":"","error_id":"10-50000"}]}}},"refName":"#/components/responses/AccountProvisioningErrorResponse500","modelName":"__components_responses_AccountProvisioningErrorResponse500"}},{"responseCode":"502","schema":{"description":"Bad Gateway","content":{"application/json":{"schema":{"title":"Bad Gateway","type":"object","properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","required":["message","field","error_id"],"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"message":{"type":"string","description":"The message representing the error from the API."},"field":{"type":"string","description":"The field associated with the error."},"error_id":{"type":"string","description":"ID representing the error as a unique nubmer."}}}}}},"example":{"errors":[{"message":"Bad Gateway","field":"","error_id":"10-50200"}]}}},"refName":"#/components/responses/AccountProvisioningErrorResponse502","modelName":"__components_responses_AccountProvisioningErrorResponse502"}},{"responseCode":"503","schema":{"description":"Service Unavailable","content":{"application/json":{"schema":{"title":"Service Unavailable","type":"object","properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","required":["message","field","error_id"],"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"message":{"type":"string","description":"The message representing the error from the API."},"field":{"type":"string","description":"The field associated with the error."},"error_id":{"type":"string","description":"ID representing the error as a unique nubmer."}}}}}},"example":{"errors":[{"message":"Service Unavailable","field":"","error_id":"10-50300"}]}}},"refName":"#/components/responses/AccountProvisioningErrorResponse503","modelName":"__components_responses_AccountProvisioningErrorResponse503"}},{"responseCode":"504","schema":{"description":"Endpoint request timed out","content":{"application/json":{"schema":{"title":"Endpoint request timed out","type":"object","properties":{"errors":{"type":"array","items":{"title":"Error","type":"object","required":["message","field","error_id"],"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"message":{"type":"string","description":"The message representing the error from the API."},"field":{"type":"string","description":"The field associated with the error."},"error_id":{"type":"string","description":"ID representing the error as a unique nubmer."}}}}}},"example":{"errors":[{"message":"Endpoint request timed out","field":"","error_id":"10-50400"}]}}},"refName":"#/components/responses/AccountProvisioningErrorResponse504","modelName":"__components_responses_AccountProvisioningErrorResponse504"}}] ``` Update customer account offerings ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const accountID = "accountID"; const data = { offerings: [ { name: "org.ei.free.v1", type: "package", quantity: 1, }, ], }; const request = { url: `/v3/partners/accounts/${accountID}/offerings`, method: "PUT", body: data, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) accountID = "accountID" data = { "offerings": [{"name": "org.ei.free.v1", "type": "package", "quantity": 1}] } response = sg.client.partners.accounts._(accountID).offerings.put( request_body=data ) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var accountID = "accountID"; var data = @"{ ""offerings"": [ { ""name"": ""org.ei.free.v1"", ""type"": ""package"", ""quantity"": 1 } ] }"; var response = await client.RequestAsync( method: SendGridClient.Method.PUT, urlPath: $"partners/accounts/{accountID}/offerings", requestBody: data); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; import org.json.JSONObject; import java.util.HashMap; import java.util.Arrays; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.PUT); request.setEndpoint("/partners/accounts/accountID/offerings"); request.setBody(new JSONObject(new HashMap() { { put("offerings", Arrays.asList(new HashMap() { { put("name", "org.ei.free.v1"); put("type", "package"); put("quantity", 1); } })); } }).toString()); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/partners/accounts/accountID/offerings", host) request.Method = "PUT" request.Body = []byte(`{ "offerings": [ { "name": "org.ei.free.v1", "type": "package", "quantity": 1 } ] }`) response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $request_body = json_decode('{ "offerings": [ { "name": "org.ei.free.v1", "type": "package", "quantity": 1 } ] }'); $accountID = "accountID"; try { $response = $sg->client ->partners() ->accounts() ->_($accountID) ->offerings() ->put($request_body); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) accountID = "accountID" data = JSON.parse('{ "offerings": [ { "name": "org.ei.free.v1", "type": "package", "quantity": 1 } ] }') response = sg.client.partners.accounts._(accountID).offerings.put(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X PUT "https://api.sendgrid.com/v3/partners/accounts/accountID/offerings" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"offerings": [{"name": "org.ei.free.v1", "type": "package", "quantity": 1}]}' ```