# Create Account ## 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 account operations allow you to create, retrieve, and authenticate customer accounts. The Create Account operation allows you to create a new customer account. The Create Account operation requires a JSON request body containing a `profile` object and an array of `offerings` objects. ### Profile object The `profile` object contains a customer's identity information such as their `first_name`, `last_name`, and `email`. The fields in the `profile` object are optional — the customer will be prompted at their first login to enter any profile information you choose not to include when creating the account. See the API reference below for all `profile` fields. ### Offerings array The `offerings` array contains offering objects that list the offering's `name`, `type`, and `quantity`. The offerings array is required, and it defines the Twilio SendGrid features or *offerings* available to the customer's account. The offerings available will depend on your agreement with Twilio SendGrid. To retrieve a list of all the offerings that you can assign to a customer account, use the [List Offerings endpoint](/docs/sendgrid/api-reference/account-provisioning-api-offering-operations/list-offerings). Because the available offerings will change infrequently, you may wish to cache the List Offerings response rather than call the endpoint before each account creation or update. A new account may start on any email offering at any price point. Upgrades and downgrades are also available immediately after account provisioning. ### Response The response to a new account creation is the Twilio Sendgrid account ID. This account ID is used in all subsequent calls to the Account Provisioning API, so you should record it in your database for future use. ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/partners/accounts","method":"post","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"for EU regional subusers"}]} ``` Creates a new account, with specified offering, under the organization. ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}},{"name":"T-Test-Account","in":"header","description":"**OPTIONAL** Custom request header provided ONLY for a test account","schema":{"type":"string"},"required":false,"refName":"#/components/parameters/AccountProvisioningTestHeader","modelName":"__components_parameters_AccountProvisioningTestHeader"}] ``` ### Request body ```json {"schema":{"title":"CreateAccountParams","type":"object","required":["offerings"],"properties":{"profile":{"title":"Profile","type":"object","example":{"first_name":"Sender","last_name":"Wiz","company_name":"Example Co","company_website":"https://example.com","email":"mail@example.com","timezone":"Asia/Tokyo"},"refName":"AccountProvisioningProfile","modelName":"AccountProvisioningProfile","properties":{"first_name":{"type":"string","description":"First name of the account holder"},"last_name":{"type":"string","description":"Last name of the account holder"},"company_name":{"type":"string","description":"Company name of the account holder"},"company_website":{"type":"string","description":"Company website of the account holder"},"email":{"type":"string","description":"Email of the account holder"},"phone":{"type":"string","description":"Phone number with a maximum of fifteen digits formatted using the E.164 standard consisting of [+] [country code] [subscriber number including area code]"},"timezone":{"type":"string","description":"Area/Location as listed in the [IANA Time Zone database](https://www.iana.org/time-zones)"}}},"offerings":{"type":"array","description":"List of offering names 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":{"profile":{"first_name":"Sender","last_name":"Wiz","company_name":"Twilio SendGrid","company_website":"https://sendgrid.com","email":"test@test.com","timezone":"Asia/Tokyo"},"offerings":[{"name":"org.ei.free.v1","type":"package","quantity":1}]},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"201","schema":{"description":"Created","content":{"application/json":{"schema":{"title":"AccountID","type":"object","required":["account_id"],"example":{"account_id":"sg2a2bcd3ef4ab5c67d8efab91c01de2fa"},"refName":"AccountProvisioningAccountId","modelName":"AccountProvisioningAccountId","properties":{"account_id":{"type":"string","description":"Twilio SendGrid account ID"}}}}}}},{"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"}}] ``` Create a customer account ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const data = { profile: { first_name: "Sender", last_name: "Wiz", company_name: "Twilio SendGrid", company_website: "https://sendgrid.com", email: "test@test.com", timezone: "Asia/Tokyo", }, offerings: [ { name: "org.ei.free.v1", type: "package", quantity: 1, }, ], }; const request = { url: `/v3/partners/accounts`, method: "POST", 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")) data = { "profile": { "first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo", }, "offerings": [{"name": "org.ei.free.v1", "type": "package", "quantity": 1}], } response = sg.client.partners.accounts.post(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 data = @"{ ""profile"": { ""first_name"": ""Sender"", ""last_name"": ""Wiz"", ""company_name"": ""Twilio SendGrid"", ""company_website"": ""https://sendgrid.com"", ""email"": ""test@test.com"", ""timezone"": ""Asia/Tokyo"" }, ""offerings"": [ { ""name"": ""org.ei.free.v1"", ""type"": ""package"", ""quantity"": 1 } ] }"; var response = await client.RequestAsync( method: SendGridClient.Method.POST, urlPath: "partners/accounts", 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.POST); request.setEndpoint("/partners/accounts"); request.setBody(new JSONObject(new HashMap() { { put("profile", new HashMap() { { put("first_name", "Sender"); put("last_name", "Wiz"); put("company_name", "Twilio SendGrid"); put("company_website", "https://sendgrid.com"); put("email", "test@test.com"); put("timezone", "Asia/Tokyo"); } }); 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", host) request.Method = "POST" request.Body = []byte(`{ "profile": { "first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo" }, "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('{ "profile": { "first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo" }, "offerings": [ { "name": "org.ei.free.v1", "type": "package", "quantity": 1 } ] }'); try { $response = $sg->client ->partners() ->accounts() ->post($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']) data = JSON.parse('{ "profile": { "first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo" }, "offerings": [ { "name": "org.ei.free.v1", "type": "package", "quantity": 1 } ] }') response = sg.client.partners.accounts.post(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X POST "https://api.sendgrid.com/v3/partners/accounts" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"profile": {"first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo"}, "offerings": [{"name": "org.ei.free.v1", "type": "package", "quantity": 1}]}' ``` Create test customer account ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const headers = { "T-Test-Account": "true" }; const data = { profile: { first_name: "Sender", last_name: "Wiz", company_name: "Twilio SendGrid", company_website: "https://sendgrid.com", email: "test@test.com", timezone: "Asia/Tokyo", }, offerings: [ { name: "org.ei.free.v1", type: "package", quantity: 1, }, ], }; const request = { url: `/v3/partners/accounts`, method: "POST", headers: headers, 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")) headers = {"T-Test-Account": "true"} data = { "profile": { "first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo", }, "offerings": [{"name": "org.ei.free.v1", "type": "package", "quantity": 1}], } response = sg.client.partners.accounts.post( request_headers=headers, 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 headers = new Dictionary { { "T-Test-Account", "true" } }; var client = new SendGridClient(apiKey: apiKey, requestHeaders: headers); var data = @"{ ""profile"": { ""first_name"": ""Sender"", ""last_name"": ""Wiz"", ""company_name"": ""Twilio SendGrid"", ""company_website"": ""https://sendgrid.com"", ""email"": ""test@test.com"", ""timezone"": ""Asia/Tokyo"" }, ""offerings"": [ { ""name"": ""org.ei.free.v1"", ""type"": ""package"", ""quantity"": 1 } ] }"; var response = await client.RequestAsync( method: SendGridClient.Method.POST, urlPath: "partners/accounts", 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")); sg.addRequestHeader("T-Test-Account", "true"); Request request = new Request(); request.setMethod(Method.POST); request.setEndpoint("/partners/accounts"); request.setBody(new JSONObject(new HashMap() { { put("profile", new HashMap() { { put("first_name", "Sender"); put("last_name", "Wiz"); put("company_name", "Twilio SendGrid"); put("company_website", "https://sendgrid.com"); put("email", "test@test.com"); put("timezone", "Asia/Tokyo"); } }); 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", host) request.Method = "POST" request.Headers["T-Test-Account"] = "true" request.Body = []byte(`{ "profile": { "first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo" }, "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('{ "profile": { "first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo" }, "offerings": [ { "name": "org.ei.free.v1", "type": "package", "quantity": 1 } ] }'); $request_headers = ["T-Test-Account: true"]; try { $response = $sg->client ->partners() ->accounts() ->post($request_body, null, $request_headers); 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']) data = JSON.parse('{ "profile": { "first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo" }, "offerings": [ { "name": "org.ei.free.v1", "type": "package", "quantity": 1 } ] }') request_headers = JSON.parse('{ "T-Test-Account": "true" }') response = sg.client.partners.accounts.post(request_body: data, request_headers: request_headers) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X POST "https://api.sendgrid.com/v3/partners/accounts" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "T-Test-Account: true" \ --header "Content-Type: application/json" \ --data '{"profile": {"first_name": "Sender", "last_name": "Wiz", "company_name": "Twilio SendGrid", "company_website": "https://sendgrid.com", "email": "test@test.com", "timezone": "Asia/Tokyo"}, "offerings": [{"name": "org.ei.free.v1", "type": "package", "quantity": 1}]}' ```