import Surge from '@surgeapi/node';const client = new Surge({ apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted});const user = await client.users.create('acct_01j9a43avnfqzbjfch6pygv1td', { first_name: 'Brian' });console.log(user.id);
import os
from surge import Surge
client = Surge(
api_key=os.environ.get("SURGE_API_KEY"), # This is the default and can be omitted
)
user = client.users.create(
account_id="acct_01j9a43avnfqzbjfch6pygv1td",
first_name="Brian",
)
print(user.id)
require "surge_api"
surge = SurgeAPI::Client.new(api_key: "My API Key")
user = surge.users.create("acct_01j9a43avnfqzbjfch6pygv1td", first_name: "Brian")
puts(user)
{
"error": {
"message": "The requested resource could not be found.",
"type": "not_found"
}
}
Users
Create user
Create a user record under an account. Users are shown inside embeddable UI components.
POST
/
accounts
/
{account_id}
/
users
JavaScript
import Surge from '@surgeapi/node';const client = new Surge({ apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted});const user = await client.users.create('acct_01j9a43avnfqzbjfch6pygv1td', { first_name: 'Brian' });console.log(user.id);
import os
from surge import Surge
client = Surge(
api_key=os.environ.get("SURGE_API_KEY"), # This is the default and can be omitted
)
user = client.users.create(
account_id="acct_01j9a43avnfqzbjfch6pygv1td",
first_name="Brian",
)
print(user.id)
require "surge_api"
surge = SurgeAPI::Client.new(api_key: "My API Key")
user = surge.users.create("acct_01j9a43avnfqzbjfch6pygv1td", first_name: "Brian")
puts(user)
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Surge","colors":{"primary":"#8200ff","light":"#a684ff","dark":"#7f22fe"},"logo":{"light":"https://mintcdn.com/surge-67d47b03/1YdD2Aq20HHnJtCK/logo.svg?fit=max\u0026auto=format\u0026n=1YdD2Aq20HHnJtCK\u0026q=85\u0026s=fb53e91d462980a01e9b7c046c98f339","dark":"https://mintcdn.com/surge-67d47b03/1YdD2Aq20HHnJtCK/logo.svg?fit=max\u0026auto=format\u0026n=1YdD2Aq20HHnJtCK\u0026q=85\u0026s=fb53e91d462980a01e9b7c046c98f339"},"favicon":"https://mintcdn.com/surge-67d47b03/TCCrlfgdQylYa0Zn/favicon.png?fit=max\u0026auto=format\u0026n=TCCrlfgdQylYa0Zn\u0026q=85\u0026s=9026e6be7d30dc29237a92585de3ae74","api":{"openapi":"https://app.stainless.com/api/spec/documented/surge/openapi.documented.yml"},"navbar":{"links":[{"href":"mailto:support@surge.app","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://hq.surge.app"}},"footer":{"socials":{"x":"https://x.com/surgeapi","github":"https://github.com/surgeapi","linkedin":"https://www.linkedin.com/company/surgeapi"}},"seo":{"metatags":{"og:image":"https://surgemsg.com/images/surge-preview-9b01c93f5b24bb5128b47c354c371546.jpg?vsn=d"},"indexing":"navigable"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"surge-67d47b03","hasAudioNarration":false,"actualSubdomain":"surge-67d47b03","customDomains":["docs.surge.app"],"gitSource":{"type":"github","owner":"surgeapi","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aaae7802f98a5cbbdae4267","collectionId":"0e5f70d2-2f10-4a77-ba88-b304ffb0016b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aaae7802f98a5cbbdae4267"},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aaae7802f98a5cbbdae4267","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":60},{"language":"default","tag":"Endpoints","count":41},{"language":"default","tag":"Documentation","count":38},{"language":"default","tag":"Webhooks","count":16},{"language":"default","tag":"Events","count":14},{"language":"default","tag":"Phone numbers","count":10},{"language":"default","tag":"SDKs","count":10},{"language":"default","tag":"Register your business","count":9},{"language":"default","tag":"Accounts","count":6},{"language":"default","tag":"Users","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{height:2rem}"}],"page":{"pagePath":"api-reference/endpoint/users/create","slug":"/api-reference/endpoint/users/create","pageMetadata":{"title":"Create user","description":"Create a user record under an account. Users are shown inside embeddable UI components.","openapi":"POST /accounts/{account_id}/users","href":"/api-reference/endpoint/users/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a user record under an account. Users are shown inside embeddable UI components.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create user","description":"Create a user record under an account. Users are shown inside embeddable UI components.","openapi":"POST /accounts/{account_id}/users","href":"/api-reference/endpoint/users/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create a user record under an account. Users are shown inside embeddable UI components.","operationId":"CreateUser","parameters":["e2973c55-3ef3-45c2-9d32-8fa40d31c841"],"requestBody":"fc2058e5-be39-480b-91a8-3b94589bedf2","responses":{"201":"113154e7-3dde-4681-9ef3-7c97e093149a","default":"735e3c00-a427-4c79-b7d6-260ffe750240"},"summary":"Create a user","tags":["Users"],"x-codeSamples":[{"lang":"JavaScript","source":"import Surge from '@surgeapi/node';\n\nconst client = new Surge({\n apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted\n});\n\nconst user = await client.users.create('acct_01j9a43avnfqzbjfch6pygv1td', { first_name: 'Brian' });\n\nconsole.log(user.id);"},{"lang":"Python","source":"import os\nfrom surge import Surge\n\nclient = Surge(\n api_key=os.environ.get(\"SURGE_API_KEY\"), # This is the default and can be omitted\n)\nuser = client.users.create(\n account_id=\"acct_01j9a43avnfqzbjfch6pygv1td\",\n first_name=\"Brian\",\n)\nprint(user.id)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stainless-sdks/surge-go\"\n\t\"github.com/stainless-sdks/surge-go/option\"\n)\n\nfunc main() {\n\tclient := surge.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tuser, err := client.Users.New(\n\t\tcontext.TODO(),\n\t\t\"acct_01j9a43avnfqzbjfch6pygv1td\",\n\t\tsurge.UserNewParams{\n\t\t\tFirstName: \"Brian\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", user.ID)\n}\n"},{"lang":"Ruby","source":"require \"surge_api\"\n\nsurge = SurgeAPI::Client.new(api_key: \"My API Key\")\n\nuser = surge.users.create(\"acct_01j9a43avnfqzbjfch6pygv1td\", first_name: \"Brian\")\n\nputs(user)"},{"lang":"PHP","source":"\u003c?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\nuse Surge\\Client;\nuse Surge\\Core\\Exceptions\\APIException;\n\n$client = new Client(apiKey: getenv('SURGE_API_KEY') ?: 'My API Key');\n\ntry {\n $user = $client->users->create(\n 'acct_01j9a43avnfqzbjfch6pygv1td',\n firstName: 'Brian',\n lastName: 'O\\'Conner',\n metadata: ['email' => 'boconner@toretti.family', 'user_id' => '1234'],\n photoURL: 'https://toretti.family/people/brian.jpg',\n );\n\n var_dump($user);\n} catch (APIException $e) {\n echo $e->getMessage();\n}"}],"method":"post","type":"path","servers":["15b64cdc-1141-4e54-9b9c-89ee48bd886f"],"security":["4cff3486-9f0b-4fb1-a04d-30a9c3d480fa"],"path":"/accounts/{account_id}/users","baseUrlOptions":["https://api.surge.app"],"title":"Create a user","codeSamples":[{"lang":"JavaScript","source":"import Surge from '@surgeapi/node';\n\nconst client = new Surge({\n apiKey: process.env['SURGE_API_KEY'], // This is the default and can be omitted\n});\n\nconst user = await client.users.create('acct_01j9a43avnfqzbjfch6pygv1td', { first_name: 'Brian' });\n\nconsole.log(user.id);"},{"lang":"Python","source":"import os\nfrom surge import Surge\n\nclient = Surge(\n api_key=os.environ.get(\"SURGE_API_KEY\"), # This is the default and can be omitted\n)\nuser = client.users.create(\n account_id=\"acct_01j9a43avnfqzbjfch6pygv1td\",\n first_name=\"Brian\",\n)\nprint(user.id)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stainless-sdks/surge-go\"\n\t\"github.com/stainless-sdks/surge-go/option\"\n)\n\nfunc main() {\n\tclient := surge.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tuser, err := client.Users.New(\n\t\tcontext.TODO(),\n\t\t\"acct_01j9a43avnfqzbjfch6pygv1td\",\n\t\tsurge.UserNewParams{\n\t\t\tFirstName: \"Brian\",\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", user.ID)\n}\n"},{"lang":"Ruby","source":"require \"surge_api\"\n\nsurge = SurgeAPI::Client.new(api_key: \"My API Key\")\n\nuser = surge.users.create(\"acct_01j9a43avnfqzbjfch6pygv1td\", first_name: \"Brian\")\n\nputs(user)"},{"lang":"PHP","source":"\u003c?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\nuse Surge\\Client;\nuse Surge\\Core\\Exceptions\\APIException;\n\n$client = new Client(apiKey: getenv('SURGE_API_KEY') ?: 'My API Key');\n\ntry {\n $user = $client->users->create(\n 'acct_01j9a43avnfqzbjfch6pygv1td',\n firstName: 'Brian',\n lastName: 'O\\'Conner',\n metadata: ['email' => 'boconner@toretti.family', 'user_id' => '1234'],\n photoURL: 'https://toretti.family/people/brian.jpg',\n );\n\n var_dump($user);\n} catch (APIException $e) {\n echo $e->getMessage();\n}"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"e2973c55-3ef3-45c2-9d32-8fa40d31c841":{"in":"path","name":"account_id","required":true,"schema":{"description":"The account for which the user should be created.","example":"acct_01j9a43avnfqzbjfch6pygv1td","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"description":"POST body for creating a user","example":{"first_name":"Brian","last_name":"O'Conner","metadata":{"email":"boconner@toretti.family","user_id":"1234"},"photo_url":"https://toretti.family/people/brian.jpg"},"properties":{"first_name":{"description":"The user's first name.","type":"string","isRequired":true,"uniqueKey":"first_name","typeLabel":"string"},"last_name":{"description":"The user's last name.","type":"string","uniqueKey":"last_name","typeLabel":"string"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs that will be stored with the object.","maxProperties":50,"properties":{},"title":"Metadata","type":"object","uniqueKey":"metadata","typeLabel":"Metadata · object"},"photo_url":{"description":"URL of a photo to be used as the user's avatar.","format":"uri","type":"string","uniqueKey":"photo_url","typeLabel":"string\u003curi>"}},"required":["first_name"],"title":"UserParams","type":"object","uniqueKey":"","typeLabel":"UserParams · object"},"examples":{"Example":{"title":"Example","value":{"first_name":"Brian","last_name":"O'Conner","metadata":{"email":"boconner@toretti.family","user_id":"1234"},"photo_url":"https://toretti.family/people/brian.jpg"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"113154e7-3dde-4681-9ef3-7c97e093149a":{"content":{"application/json":{"schema":{"description":"A user of the app","example":{"first_name":"Brian","id":"usr_01j9dwavghe1ttppewekjjkfrx","last_name":"O'Conner","metadata":{"email":"boconner@toretti.family","user_id":"1234"},"photo_url":"https://toretti.family/people/brian.jpg"},"properties":{"first_name":{"description":"The user's first name.","type":"string","isRequired":true,"uniqueKey":"first_name","typeLabel":"string"},"id":{"description":"Unique identifier for the object.","type":"string","uniqueKey":"id","typeLabel":"string"},"last_name":{"description":"The user's last name.","type":"string","uniqueKey":"last_name","typeLabel":"string"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Set of key-value pairs that will be stored with the object.","maxProperties":50,"properties":{},"title":"Metadata","type":"object","uniqueKey":"metadata","typeLabel":"Metadata · object"},"photo_url":{"description":"URL of a photo to be used as the user's avatar.","format":"uri","type":"string","uniqueKey":"photo_url","typeLabel":"string\u003curi>"}},"required":["first_name"],"title":"User","type":"object","uniqueKey":"","typeLabel":"User · object"},"examples":{"Example":{"title":"Example","value":{"first_name":"Brian","id":"usr_01j9dwavghe1ttppewekjjkfrx","last_name":"O'Conner","metadata":{"email":"boconner@toretti.family","user_id":"1234"},"photo_url":"https://toretti.family/people/brian.jpg"}}},"exampleType":"generated"}},"description":"Created user","exampleType":"generated"},"735e3c00-a427-4c79-b7d6-260ffe750240":{"content":{"application/json":{"schema":{"description":"An error response","example":{"error":{"message":"The requested resource could not be found.","type":"not_found"}},"properties":{"error":{"description":"An error response","example":{"message":"The requested resource was not found.","type":"not_found"},"properties":{"message":{"description":"A human-readable error message.","example":"The requested resource was not found.","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"description":"A unique error code.","example":"not_found","type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"detail":{"additionalProperties":true,"description":"Additional details about the error.","type":"object","uniqueKey":"error.detail","typeLabel":"object"}},"required":["type","message"],"title":"Error","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"Error · object"}},"required":["error"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"The requested resource could not be found.","type":"not_found"}}}},"exampleType":"generated"}},"description":"Error","exampleType":"generated"}},"security":{"4cff3486-9f0b-4fb1-a04d-30a9c3d480fa":{"authorization":{"bearerFormat":"Surge API token","scheme":"bearer","type":"http","scopes":[]}}},"servers":{"15b64cdc-1141-4e54-9b9c-89ee48bd886f":{"url":"https://api.surge.app"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"Surge API token","scheme":"bearer","type":"http","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"authorization","name":"Authorization"}],"title":"authorization"}]},"originalFileLocation":"https://app.stainless.com/api/spec/documented/surge/openapi.documented.yml"},"subdomain":"surge-67d47b03","siteName":"Surge","title":"Create user - Surge","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-21T23:32:26.731Z","originalFileLocation":"api-reference/endpoint/users/create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a user record under an account. Users are shown inside embeddable UI components.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Surge\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create user - Surge\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a user record under an account. Users are shown inside embeddable UI components.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Surge\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.surge.app/api-reference/endpoint/users/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://surgemsg.com/images/surge-preview-9b01c93f5b24bb5128b47c354c371546.jpg?vsn=d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create user - Surge\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a user record under an account. Users are shown inside embeddable UI components.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://surgemsg.com/images/surge-preview-9b01c93f5b24bb5128b47c354c371546.jpg?vsn=d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/surge-67d47b03/sXzShSiekorghOlZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Surge\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8200ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.surge.app/api-reference/endpoint/users/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/users/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.surge.app/#organization\",\"name\":\"Surge\",\"url\":\"https://docs.surge.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/surge-67d47b03/1YdD2Aq20HHnJtCK/logo.svg?fit=max\u0026auto=format\u0026n=1YdD2Aq20HHnJtCK\u0026q=85\u0026s=fb53e91d462980a01e9b7c046c98f339\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.surge.app#website\",\"name\":\"Surge\",\"url\":\"https://docs.surge.app\",\"publisher\":{\"@id\":\"https://docs.surge.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.surge.app/api-reference/endpoint/users/create#webpage\",\"url\":\"https://docs.surge.app/api-reference/endpoint/users/create\",\"name\":\"Create user\",\"description\":\"Create a user record under an account. Users are shown inside embeddable UI components.\",\"dateModified\":\"2026-07-21T23:32:26.731Z\",\"isPartOf\":{\"@id\":\"https://docs.surge.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.surge.app/api-reference/endpoint/users/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.surge.app/api-reference/endpoint/users/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.surge.app/api-reference/endpoint/accounts/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create user\",\"item\":\"https://docs.surge.app/api-reference/endpoint/users/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.surge.app/api-reference/endpoint/users/create#apireference\",\"headline\":\"Create user\",\"name\":\"Create user\",\"description\":\"Create a user record under an account. Users are shown inside embeddable UI components.\",\"url\":\"https://docs.surge.app/api-reference/endpoint/users/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.surge.app/api-reference/endpoint/users/create#webpage\"},\"image\":\"https://surgemsg.com/images/surge-preview-9b01c93f5b24bb5128b47c354c371546.jpg?vsn=d\",\"dateModified\":\"2026-07-21T23:32:26.731Z\",\"publisher\":{\"@id\":\"https://docs.surge.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.surge.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Surge\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Surge","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/overview/what-is-surge"}]},{"anchor":"SDKs","icon":"code","pages":[{"title":"SDKs","href":"/sdks"}]},{"anchor":"API Reference","icon":"terminal","groups":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Error Reference","href":"/api-reference/errors"}]},{"group":"Endpoints","pages":[{"group":"Accounts","pages":[{"title":"Create account","openapi":"POST /accounts","href":"/api-reference/endpoint/accounts/create"},{"title":"List accounts","openapi":"GET /accounts","href":"/api-reference/endpoint/accounts/list"},{"title":"Retrieve account","openapi":"GET /accounts/{id}","href":"/api-reference/endpoint/accounts/get"},{"title":"Check account status","openapi":"GET /accounts/{account_id}/status","href":"/api-reference/endpoint/accounts/check-status"},{"title":"Update account","openapi":"PATCH /accounts/{id}","href":"/api-reference/endpoint/accounts/update"},{"title":"Archive account","openapi":"DELETE /accounts/{id}","href":"/api-reference/endpoint/accounts/archive"}]},{"group":"Attachments","pages":[{"title":"Retrieve attachment file","openapi":"GET /attachments/{attachment_id}/file","href":"/api-reference/endpoint/attachments/get-file"}]},{"group":"Audiences","pages":[{"title":"Create audience","openapi":"POST /accounts/{account_id}/audiences","href":"/api-reference/endpoint/audiences/create"},{"title":"Add contact to audience","openapi":"POST /audiences/{audience_id}/contacts","href":"/api-reference/endpoint/audiences/add-contact"},{"title":"List audience contacts","openapi":"GET /audiences/{audience_id}/contacts","href":"/api-reference/endpoint/audiences/list-contacts"}]},{"group":"Blasts","pages":[{"title":"Create blast","openapi":"POST /accounts/{account_id}/blasts","href":"/api-reference/endpoint/blasts/create"}]},{"group":"Campaigns","pages":[{"title":"Create campaign","openapi":"POST /accounts/{account_id}/campaigns","href":"/api-reference/endpoint/campaigns/create"},{"title":"List campaigns","openapi":"GET /accounts/{account_id}/campaigns","href":"/api-reference/endpoint/campaigns/list"},{"title":"Retrieve campaign","openapi":"GET /campaigns/{id}","href":"/api-reference/endpoint/campaigns/get"},{"title":"Update campaign","openapi":"PATCH /campaigns/{id}","href":"/api-reference/endpoint/campaigns/update"},{"title":"Resend brand verification OTP","openapi":"POST /accounts/{account_id}/brand_verification_messages","href":"/api-reference/endpoint/campaigns/resend-brand-verification-message"}]},{"group":"Contacts","pages":[{"title":"Create contact","openapi":"POST /accounts/{account_id}/contacts","href":"/api-reference/endpoint/contacts/create"},{"title":"List contacts","openapi":"GET /accounts/{account_id}/contacts","href":"/api-reference/endpoint/contacts/list"},{"title":"Retrieve contact","openapi":"GET /contacts/{id}","href":"/api-reference/endpoint/contacts/get"},{"title":"Update contact","openapi":"PATCH /contacts/{id}","href":"/api-reference/endpoint/contacts/update"}]},{"group":"Messages","pages":[{"title":"Send message","openapi":"POST /accounts/{account_id}/messages","href":"/api-reference/endpoint/messages/create"},{"title":"List messages","openapi":"GET /accounts/{account_id}/messages","href":"/api-reference/endpoint/messages/list"},{"title":"Retrieve message","openapi":"GET /messages/{id}","href":"/api-reference/endpoint/messages/get"}]},{"group":"Phone numbers","pages":[{"title":"Purchase phone number","openapi":"POST /accounts/{account_id}/phone_numbers","href":"/api-reference/endpoint/phone-numbers/purchase"},{"title":"List phone numbers","openapi":"GET /accounts/{account_id}/phone_numbers","href":"/api-reference/endpoint/phone-numbers/list"},{"title":"Retrieve phone number","openapi":"GET /phone_numbers/{id}","href":"/api-reference/endpoint/phone-numbers/get"},{"title":"Update phone number","openapi":"PATCH /phone_numbers/{id}","href":"/api-reference/endpoint/phone-numbers/update"},{"title":"Release phone number","openapi":"DELETE /phone_numbers/{id}","href":"/api-reference/endpoint/phone-numbers/release"},{"title":"List available numbers","openapi":"GET /accounts/{account_id}/available_phone_numbers","href":"/api-reference/endpoint/phone-numbers/list-available-numbers"}]},{"group":"Recordings","pages":[{"title":"List recordings","openapi":"GET /accounts/{account_id}/recordings","href":"/api-reference/endpoint/recordings/list"},{"title":"Retrieve recording","openapi":"GET /recordings/{id}","href":"/api-reference/endpoint/recordings/get"},{"title":"Delete recording","openapi":"DELETE /recordings/{id}","href":"/api-reference/endpoint/recordings/delete"},{"title":"Download recording file","description":"Download the audio file for a call recording. Returns a redirect to a short-lived signed URL.","openapi":"GET /recordings/{recording_id}/file","href":"/api-reference/endpoint/recordings/get-file"}]},{"group":"Users","pages":[{"title":"Create user","openapi":"POST /accounts/{account_id}/users","href":"/api-reference/endpoint/users/create"},{"title":"List users","description":"List all users provisioned under an account with cursor-based pagination.","openapi":"GET /accounts/{account_id}/users","href":"/api-reference/endpoint/users/list"},{"title":"Retrieve user","openapi":"GET /users/{id}","href":"/api-reference/endpoint/users/get"},{"title":"Update user","openapi":"PATCH /users/{id}","href":"/api-reference/endpoint/users/update"},{"title":"Delete user","openapi":"DELETE /users/{id}","href":"/api-reference/endpoint/users/delete"},{"title":"Create user token","openapi":"POST /users/{user_id}/tokens","href":"/api-reference/endpoint/users/create-token"}]},{"group":"Verifications","pages":[{"title":"Create verification","openapi":"POST /accounts/{account_id}/verifications","href":"/api-reference/endpoint/verifications/create"},{"title":"Check verification","openapi":"POST /verifications/{id}/checks","href":"/api-reference/endpoint/verifications/check"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks Overview","href":"/api-reference/webhooks/intro"},{"title":"Signature Verification","href":"/api-reference/webhooks/signature-validation"},{"group":"Events","pages":[{"title":"message.sent","openapi":"webhook messageSent","href":"/api-reference/webhooks/message/sent"},{"title":"message.delivered","openapi":"webhook messageDelivered","href":"/api-reference/webhooks/message/delivered"},{"title":"message.failed","openapi":"webhook messageFailed","href":"/api-reference/webhooks/message/failed"},{"title":"message.received","openapi":"webhook messageReceived","href":"/api-reference/webhooks/message/received"},{"title":"contact.opted_in","openapi":"webhook contactOptedIn","href":"/api-reference/webhooks/contact/opted_in"},{"title":"contact.opted_out","openapi":"webhook contactOptedOut","href":"/api-reference/webhooks/contact/opted_out"},{"title":"conversation.created","openapi":"webhook conversationCreated","href":"/api-reference/webhooks/conversation/created"},{"title":"campaign.approved","openapi":"webhook campaignApproved","href":"/api-reference/webhooks/campaign/approved"},{"title":"phone_number.imported","openapi":"webhook phoneNumberImported","href":"/api-reference/webhooks/phone_number/imported"},{"title":"phone_number.attached_to_campaign","openapi":"webhook phoneNumberAttachedToCampaign","href":"/api-reference/webhooks/phone_number/attached_to_campaign"},{"title":"link.followed","openapi":"webhook linkFollowed","href":"/api-reference/webhooks/link/followed"},{"title":"call.ended","openapi":"webhook callEnded","href":"/api-reference/webhooks/call/ended"},{"title":"recording.completed","openapi":"webhook recordingCompleted","href":"/api-reference/webhooks/recording/completed"},{"title":"voicemail.received","openapi":"webhook voicemailReceived","href":"/api-reference/webhooks/voicemail/received"}]}]}]},{"anchor":"Resources","icon":"folder-open","pages":[{"title":"Resources","href":"/resources/hipaa"}]}]},"basePath":"","title":"Create user - Surge","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}