---
title: "POST /api/users"
method: POST
path: "/api/users"
tags: ["User"]
---

# POST /api/users

`POST /api/users`

## Request

- Base URL: `https://data.deluxe.com` (the document declares no server; this is the origin it was published from)
- URL: `https://data.deluxe.com/api/users`
- Auth: API key in header `X-Deluxe-Auth`
- TypeScript: <https://skmtc.dev/deluxe/apis/append-api/docs/api/users/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- User
  - `externalId` string, nullable
  - `tokens` UserSecurityToken[], nullable
    - `id` integer
    - `token` string, uuid
    - `isAdmin` boolean
    - `user` User (recursive)
  - `userMartAttributes` UserMartAttribute[], nullable
    - `user` User (recursive)
    - `martAttribute` MartAttribute
      - `mart` Mart
        - `alias` string, nullable
        - `server` string, nullable
        - `database` string, nullable
        - `username` string, nullable
        - `password` string, nullable
        - `searchTypeId` integer
        - `audit` boolean
        - `martAttributes` MartAttribute[], nullable
        - `martSuppliers` MartSupplier[], nullable
          - `mart` Mart (recursive)
          - `supplier` Supplier
            - `alias` string, nullable
            - `name` string, nullable
            - `id` integer
          - `tableName` string, nullable
          - `id` integer
        - `attributes` string[], nullable
        - `suppliers` string[], nullable
        - `id` integer
      - `attribute` Attribute
        - `alias` string, nullable
        - `type` 1
        - `id` integer
      - `columnName` string, nullable
      - `dataDictionaryItemId` integer
      - `id` integer
    - `id` integer
  - `userMartSuppliers` UserMartSupplier[], nullable
    - `user` User (recursive)
    - `martSupplier` MartSupplier
      - `mart` Mart
        - `alias` string, nullable
        - `server` string, nullable
        - `database` string, nullable
        - `username` string, nullable
        - `password` string, nullable
        - `searchTypeId` integer
        - `audit` boolean
        - `martAttributes` MartAttribute[], nullable
          - `mart` Mart (recursive)
          - `attribute` Attribute
            - `alias` string, nullable
            - `type` 1
            - `id` integer
          - `columnName` string, nullable
          - `dataDictionaryItemId` integer
          - `id` integer
        - `martSuppliers` MartSupplier[], nullable
        - `attributes` string[], nullable
        - `suppliers` string[], nullable
        - `id` integer
      - `supplier` Supplier
        - `alias` string, nullable
        - `name` string, nullable
        - `id` integer
      - `tableName` string, nullable
      - `id` integer
    - `id` integer
  - `availableMarts` Mart[], nullable
    - `alias` string, nullable
    - `server` string, nullable
    - `database` string, nullable
    - `username` string, nullable
    - `password` string, nullable
    - `searchTypeId` integer
    - `audit` boolean
    - `martAttributes` MartAttribute[], nullable
      - `mart` Mart (recursive)
      - `attribute` Attribute
        - `alias` string, nullable
        - `type` 1
        - `id` integer
      - `columnName` string, nullable
      - `dataDictionaryItemId` integer
      - `id` integer
    - `martSuppliers` MartSupplier[], nullable
      - `mart` Mart (recursive)
      - `supplier` Supplier
        - `alias` string, nullable
        - `name` string, nullable
        - `id` integer
      - `tableName` string, nullable
      - `id` integer
    - `attributes` string[], nullable
    - `suppliers` string[], nullable
    - `id` integer
  - `id` integer

## Response `200`

Success

- User
  - `externalId` string, nullable
  - `tokens` UserSecurityToken[], nullable
    - `id` integer
    - `token` string, uuid
    - `isAdmin` boolean
    - `user` User (recursive)
  - `userMartAttributes` UserMartAttribute[], nullable
    - `user` User (recursive)
    - `martAttribute` MartAttribute
      - `mart` Mart
        - `alias` string, nullable
        - `server` string, nullable
        - `database` string, nullable
        - `username` string, nullable
        - `password` string, nullable
        - `searchTypeId` integer
        - `audit` boolean
        - `martAttributes` MartAttribute[], nullable
        - `martSuppliers` MartSupplier[], nullable
          - `mart` Mart (recursive)
          - `supplier` Supplier
            - `alias` string, nullable
            - `name` string, nullable
            - `id` integer
          - `tableName` string, nullable
          - `id` integer
        - `attributes` string[], nullable
        - `suppliers` string[], nullable
        - `id` integer
      - `attribute` Attribute
        - `alias` string, nullable
        - `type` 1
        - `id` integer
      - `columnName` string, nullable
      - `dataDictionaryItemId` integer
      - `id` integer
    - `id` integer
  - `userMartSuppliers` UserMartSupplier[], nullable
    - `user` User (recursive)
    - `martSupplier` MartSupplier
      - `mart` Mart
        - `alias` string, nullable
        - `server` string, nullable
        - `database` string, nullable
        - `username` string, nullable
        - `password` string, nullable
        - `searchTypeId` integer
        - `audit` boolean
        - `martAttributes` MartAttribute[], nullable
          - `mart` Mart (recursive)
          - `attribute` Attribute
            - `alias` string, nullable
            - `type` 1
            - `id` integer
          - `columnName` string, nullable
          - `dataDictionaryItemId` integer
          - `id` integer
        - `martSuppliers` MartSupplier[], nullable
        - `attributes` string[], nullable
        - `suppliers` string[], nullable
        - `id` integer
      - `supplier` Supplier
        - `alias` string, nullable
        - `name` string, nullable
        - `id` integer
      - `tableName` string, nullable
      - `id` integer
    - `id` integer
  - `availableMarts` Mart[], nullable
    - `alias` string, nullable
    - `server` string, nullable
    - `database` string, nullable
    - `username` string, nullable
    - `password` string, nullable
    - `searchTypeId` integer
    - `audit` boolean
    - `martAttributes` MartAttribute[], nullable
      - `mart` Mart (recursive)
      - `attribute` Attribute
        - `alias` string, nullable
        - `type` 1
        - `id` integer
      - `columnName` string, nullable
      - `dataDictionaryItemId` integer
      - `id` integer
    - `martSuppliers` MartSupplier[], nullable
      - `mart` Mart (recursive)
      - `supplier` Supplier
        - `alias` string, nullable
        - `name` string, nullable
        - `id` integer
      - `tableName` string, nullable
      - `id` integer
    - `attributes` string[], nullable
    - `suppliers` string[], nullable
    - `id` integer
  - `id` integer

---

[API](https://skmtc.dev/deluxe/apis/append-api.md) - [All operations](https://skmtc.dev/deluxe/apis/append-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deluxe/apis/append-api/revisions/e7cde4e5a902?raw)