---
title: "addClientRegistration"
method: POST
path: "/clientregistrations/"
tags: ["clientregistrations"]
---

# addClientRegistration

`POST /clientregistrations/`

## Request

- Base URL: `https://api-hub.extensiv.com`
- URL: `https://api-hub.extensiv.com/clientregistrations/`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/extensiv/apis/hub/docs/clientregistrations/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a Client Registration

## Request body

- IClientRegistration
  - `id` string, uuid: Leave empty to allow the system to assign a uuid
  - `secret` string, uuid: System assigned - will only be returned once in the create response
  - `orgKey` string, uuid, required
  - `productAccess` IProductAccess, required
    - `can3pl` boolean: Can this Org access 3pl Warehouse Manager?
    - `canOrderManager` boolean: Can this Org access Order Manager Web?
    - `canWarehouseManagerClassicAdmin` boolean: Can this Org access Warehouse Manager Classic Admin?
    - `canWarehouseManagerUnlimitedAdmin` boolean: Can this Org access Warehouse Manager Unlimitedd Admin?
    - `canWarehouseManagerCustomerPortal` boolean: Can this Org access Warehouse Manager Customer Portal?
    - `canWarehouseManagerIntegrations` boolean: Can this Org access Warehouse Manager Integrations?
    - `canWarehouseManagerMobile` boolean: Can this Org access Warehouse Manager Mobile?
    - `canWarehouseManagerAccountManager` boolean: Can this Org access Warehouse Manager Account Manager?
    - `canIntegrationManager` boolean: Can this Org access Integration Manager?
    - `canBilling` boolean: Can this Org access Billing?
    - `canNetworkManager` boolean: Can this Org access Network Manager?
    - `canSignUp` boolean: Can this Org access 3pl Warehouse Manager Sign Up?
    - `canManagementConsole` boolean: Can this Org access Management Console?
    - `canAdmin` boolean: Can this Org access Admin?
    - `canFM` boolean: Can this Org access Fulfilment?
    - `canSmartScan` boolean: Can this Org access SmartScan?
    - `canAccountingIntegration` boolean: Can this Org access Accounting Integration?
    - `canBusinessAnalytics` boolean: Can this Org access Business Analytics?
    - `canAI` boolean: Can this Org access AI?
  - `permissions` IAppPermissions, required
    - `perms` string[], required
    - `fplperms` string[], required
  - `created` number, required: System assigned on create - just pass 0 or anything on create
  - `referrerHosts` string[], required
  - `expirationDate` number, nullable: Setting to null will remove the expiration date

## Response `201`

OK

- object
  - `data` IClientRegistration
    - `id` string, uuid: Leave empty to allow the system to assign a uuid
    - `secret` string, uuid: System assigned - will only be returned once in the create response
    - `orgKey` string, uuid, required
    - `productAccess` IProductAccess, required
      - `can3pl` boolean: Can this Org access 3pl Warehouse Manager?
      - `canOrderManager` boolean: Can this Org access Order Manager Web?
      - `canWarehouseManagerClassicAdmin` boolean: Can this Org access Warehouse Manager Classic Admin?
      - `canWarehouseManagerUnlimitedAdmin` boolean: Can this Org access Warehouse Manager Unlimitedd Admin?
      - `canWarehouseManagerCustomerPortal` boolean: Can this Org access Warehouse Manager Customer Portal?
      - `canWarehouseManagerIntegrations` boolean: Can this Org access Warehouse Manager Integrations?
      - `canWarehouseManagerMobile` boolean: Can this Org access Warehouse Manager Mobile?
      - `canWarehouseManagerAccountManager` boolean: Can this Org access Warehouse Manager Account Manager?
      - `canIntegrationManager` boolean: Can this Org access Integration Manager?
      - `canBilling` boolean: Can this Org access Billing?
      - `canNetworkManager` boolean: Can this Org access Network Manager?
      - `canSignUp` boolean: Can this Org access 3pl Warehouse Manager Sign Up?
      - `canManagementConsole` boolean: Can this Org access Management Console?
      - `canAdmin` boolean: Can this Org access Admin?
      - `canFM` boolean: Can this Org access Fulfilment?
      - `canSmartScan` boolean: Can this Org access SmartScan?
      - `canAccountingIntegration` boolean: Can this Org access Accounting Integration?
      - `canBusinessAnalytics` boolean: Can this Org access Business Analytics?
      - `canAI` boolean: Can this Org access AI?
    - `permissions` IAppPermissions, required
      - `perms` string[], required
      - `fplperms` string[], required
    - `created` number, required: System assigned on create - just pass 0 or anything on create
    - `referrerHosts` string[], required
    - `expirationDate` number, nullable: Setting to null will remove the expiration date

## Other responses

- `400`: Resource does not exist<br>Invalid request<br>Validation error<br>Database constraint error
- `403`: Insufficient permissions

---

[API](https://skmtc.dev/extensiv/apis/hub.md) - [All operations](https://skmtc.dev/extensiv/apis/hub/llms.txt) - [OpenAPI document](https://skmtc.dev/extensiv/apis/hub/revisions/3f2a4976ee74?raw)
