Create new user — Guide

First-request guide for Create new user.

API GUIDE

Create new user

Create new user

POST/admin/v1/userJSONAuthentication required

Overview

Overview Creates a new user within your Demandbase account.

Call the endpoint

Send a POST request to /admin/v1/user with the required authentication and parameters.

Build the request body

Use the JSON shape below and replace example values with your data.

Inspect the response

Use the success response shape to validate the fields your integration receives.

Quickstart

Follow these two steps to make a request and recognize a successful response.

STEP 1

Make a request

REQUEST
curl --request POST \
  --url https://uapi.demandbase.com/admin/v1/user \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"fullName":"example","email":"example","externalId":"example","permissionSets":["example"],"department":"example","view":"example"}'
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 201
{
  "externalId": "ext-123abc",
  "email": "[email protected]",
  "fullName": "Alex Morgan",
  "permissionSets": [
    "Admin"
  ],
  "department": "Customer Success",
  "view": "Standard View",
  "workspaces": [
    "Default workspace"
  ],
  "jobFunction": "Other"
}

Request anatomy

Build the request from the method, path, parameters, and payload described below.

Parameters

This endpoint does not define additional parameters.

Request body

No fields are defined for this payload.

Response anatomy

The endpoint returns 201 for the documented success case. Description: User successfully created Return: JSON object representing the new user

The response schema does not enumerate fields; inspect the example response and status code.

Rules

  • Use POST with the path /admin/v1/user.
  • Required inputs: No parameters are marked required in the published schema..
  • Authenticate every request with a valid Demandbase access token.
  • Send the request body as application/json.

Filters

This endpoint has no additional filters or parameters beyond its authentication requirements.

Errors

Handle non-success responses explicitly so your integration can report actionable failures.

StatusMeaning
400Description: Invalid request body or missing required fields Return: JSON error object
401Description: Authentication failed or missing credentials Return: JSON error status object
403Description: Returned if the authenticated credentials lacks the "User Management" permission Return: JSON error object
500Description: Returned if there was an issue on the server side and the user could not be created.

Next steps

Try the quickstart

Start with the request example, then replace the sample values with your credentials and data.

Return to the API area

Back to user

Back to top