Skip to main content
POST
/
users
{
  "userId": "<string>",
  "name": "<string>",
  "email": "jsmith@example.com",
  "msisdn": "<string>",
  "identity": "<string>",
  "customerIds": [
    "<string>"
  ],
  "customers": [
    {
      "customerId": "<string>",
      "name": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum length: 256

Body

application/json

The user to create.

Request to create a user.

​
name
string
required

Name of the user.

Example:

"John Doe"

​
email
string<email>

Email of the user.

Example:

"john.doe@example.com"

​
msisdn
string<phone>

Mobile phone number of the user.

Example:

"+15551234567"

​
identity
string

The identity of the entity, such as personal number, organization number, etc., depending on the country and customer type.

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

Response

User created successfully.

A user within the system.

​
userId
string
required

Unique identifier for the user.

​
name
string
required

Name of the user.

​
email
string<email>

Email of the user.

​
msisdn
string<phone>

Mobile phone number of the user.

​
identity
string

The identity of the entity, such as personal number, organization number, etc., depending on the country and customer type.

​
customerIds
string[]

List of customer IDs associated with this user.

The unique identifier for a customer.

​
customers
object[]
​
createdAt
string<date-time>

Date and time when the user was created.

​
updatedAt
string<date-time>

Date and time when the user was last updated.

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I