Create User

POST/users

Creates a Sail user mapped to your internal identity. Required for the server-to-server pattern. Optional for token-scoped integrations, where a user can be created implicitly at token exchange.

Body application/json

external_user_idstringrequired

Your internal identifier for this user.

emailstring<email>

The user’s email address.

first_namestring

The user’s first name.

last_namestring

The user’s last name.

phonestring

The user’s phone number.

addressobject

The user’s mailing address.

Show address properties

streetstring

Street address.

citystring

City.

statestring

State or region.

zipstring

Postal code.

countrystring

ISO 3166-1 alpha-2 country code.

Response

User created. No credential is returned. PII access uses ephemeral tokens minted on demand.

idstring

The Sail user id.

external_user_idstring

Echo of the external_user_id supplied at creation.

status"active" | "inactive"

Whether the user is active or inactive.

created_atstring<date-time>

When the user was created.

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

errorobject

The error detail.

Show error properties

codestring

Machine-readable code, e.g. not_found, token_scope_mismatch, product_not_enabled, insufficient_key_scope, insufficient_token_scope, user_token_required, user_token_expired, invalid_user_token, invalid_key_configuration, connection_not_reconnectable, rate_limited.

messagestring

Human-readable error message. May change, so match on error.code instead.

paramstring

The request field that caused the error, when applicable. Null otherwise.

curl -X POST "https://live.savewithsail.com/api/v1/users" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <token>" \ -d '{ "external_user_id": "string", "email": "user@example.com", "first_name": "string", "last_name": "string", "phone": "+1 415-555-0122", "address": { "street": "string", "city": "string", "state": "string", "zip": "string", "country": "US" } }'

const response = await fetch(`https://live.savewithsail.com/api/v1/users`, { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer <token>' }, body: JSON.stringify({ "external_user_id": "string", "email": "user@example.com", "first_name": "string", "last_name": "string", "phone": "+1 415-555-0122", "address": { "street": "string", "city": "string", "state": "string", "zip": "string", "country": "US" } }) }); const data = await response.json();

import requests response = requests.request( "POST", "https://live.savewithsail.com/api/v1/users", headers={ "Authorization": "Bearer <token>" }, json={ "external_user_id": "string", "email": "user@example.com", "first_name": "string", "last_name": "string", "phone": "+1 415-555-0122", "address": { "street": "string", "city": "string", "state": "string", "zip": "string", "country": "US" } }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://live.savewithsail.com/api/v1/users"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json", "Authorization: Bearer <token>"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "external_user_id": "string", "email": "user@example.com", "first_name": "string", "last_name": "string", "phone": "+1 415-555-0122", "address": { "street": "string", "city": "string", "state": "string", "zip": "string", "country": "US" } }'); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("POST", "https://live.savewithsail.com/api/v1/users", strings.NewReader(`{ "external_user_id": "string", "email": "user@example.com", "first_name": "string", "last_name": "string", "phone": "+1 415-555-0122", "address": { "street": "string", "city": "string", "state": "string", "zip": "string", "country": "US" } }`)) req.Header.Set("Content-Type", "application/json") req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://live.savewithsail.com/api/v1/users")) .header("Content-Type", "application/json") .header("Authorization", "Bearer <token>") .method("POST", HttpRequest.BodyPublishers.ofString("{\n \"external_user_id\": \"string\",\n \"email\": \"user@example.com\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"+1 415-555-0122\",\n \"address\": {\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zip\": \"string\",\n \"country\": \"US\"\n }\n}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://live.savewithsail.com/api/v1/users") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/json" request["Authorization"] = "Bearer <token>" request.body = "{\n \"external_user_id\": \"string\",\n \"email\": \"user@example.com\",\n \"first_name\": \"string\",\n \"last_name\": \"string\",\n \"phone\": \"+1 415-555-0122\",\n \"address\": {\n \"street\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"zip\": \"string\",\n \"country\": \"US\"\n }\n}" response = http.request(request) puts response.body