post
https://api.umbrellacost.io/api/v2/user-management/customers/
The call is used to create a new customer for an MSP
Note the request path is without the last "/"Due to documentation limitations, the request seems to end with a "/"
Do not use it as the actual request URL is https://api.umbrellacost.io/api/v2/user-management/customers
An MSP customer can take different shapes and forms.
- In-Activated - A container for linked accounts
- Activated - A customer with users and login
- Parent - An activated organization that holds users, while the accounts are managed by its child organizations
- Child - An in-activated organization that holds accounts, while the users are managed by its parent
Use this request to create the customer organization according to your needs.
Important
- Activation is irreversible. Activate only when needed — this is exactly why "create now, activate later" is useful.
- Domain usage - Reusing a domain that already belongs to an organization fails with a generic "please contact support" message and an error ID. Inform umbrella support of the domain you've tried to use, to allow adding it under your customer list.
- Permissions - Edit customers permission allows customer activation.
A few use cases to help you determine the relevant body in your request:
Please noteNot all fields appear in the use cases, just the ones that cause the difference in umbrella creation of the customer entity.
| Use case | Send in the Request | Outcome |
|---|---|---|
| Log in now, one named admin | An admin email address | Activated customer created - login created Invitation sent to that address |
| Log in now, whole company via SSO | A company domain | Anyone with an email at that domain can sign in |
| Just a container for now | Nothing extra | Customer exists, nobody can log in yet |
| A sub-customer under an existing one | The parent customer's ID | Nested under the parent; no separate login |