Create a user

Creates a new user and grants them institution membership in the institution tied to your Basic Auth integration credentials. You do not pass institutionId in the request body — the API resolves the institution from your integration. The user is created with an inactive membership, optional inline membership demographics and custom data fields, and an invitation email is sent automatically. Idempotent via Idempotency-Key header.

POST/users

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Header parameters

Idempotency-Keystringrequired

Unique key to prevent duplicate creates

Request body

requiredapplication/json

emailstring<email>required

firstNamestringrequired

lastNamestringrequired

imagestring<uri> | null

dataFieldsUserDataFieldEntry[]

Show properties

Array of UserDataFieldEntry

fieldNamestringrequired

valuestringrequired

codestring

preferredNamestring

dateOfBirthstring<date>

genderstring

Allowed:MALEFEMALEDIVERSE

nationalitiesstring[]

birthNamestring

countryOfBirthstring

placeOfBirthCitystring

Responses

201

User created

dataUserrequired

Show properties

idstringrequired

namestringrequired

emailstring<email>required

imagestring | nullrequired

activityStatusUserActivityStatusrequired

Show properties

isActivebooleanrequired

isActiveFromstring<date-time> | nullrequired

isActiveUntilstring<date-time> | nullrequired

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

400

Bad Request

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

401

Unauthorized

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

409

Conflict

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

429

Too Many Requests

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

500

Internal Server Error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

Idempotency-Keyheader*Unique key to prevent duplicate creates

Bodyapplication/json

Request body

Request

curl -X POST 'https://fuxam.app/api/v4/users' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Idempotency-Key: string' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "jane@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "code": "STU-001",
  "dataFields": [
    {
      "fieldName": "studentId",
      "value": "S-12345"
    }
  ]
}'

const response = await fetch("https://fuxam.app/api/v4/users", {
  method: "POST",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Idempotency-Key": "string",
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"jane@example.com\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"code\": \"STU-001\",\n  \"dataFields\": [\n    {\n      \"fieldName\": \"studentId\",\n      \"value\": \"S-12345\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://fuxam.app/api/v4/users",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Idempotency-Key": "string",
        "Content-Type": "application/json"
    },
    data="{\n  \"email\": \"jane@example.com\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"code\": \"STU-001\",\n  \"dataFields\": [\n    {\n      \"fieldName\": \"studentId\",\n      \"value\": \"S-12345\"\n    }\n  ]\n}",
)

Response

{
  "data": {
    "id": "clx1234567890",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "image": "string",
    "activityStatus": {
      "isActive": true,
      "isActiveFrom": "2026-01-01T00:00:00.000Z",
      "isActiveUntil": "2019-08-24T14:15:22Z"
    }
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}