Skip to main content
POST
/
customers
/
{customerId}
/
users
{
  "userId": "<string>",
  "name": "<string>",
  "role": "MEMBER"
}

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

Path Parameters

​
customerId
string
required

The unique identifier of the customer.

Body

application/json

The user to add to the customer.

Request to add a user to a customer.

​
userId
string

The unique identifier of the user to add to the customer.

​
role
enum<string>
default:MEMBER

The role of the user within the customer. Defaults to 'MEMBER' if not specified.

Available options:
MEMBER,
MANAGER,
ADMIN

Response

User added to customer successfully.

An embedded representation of a user.

​
userId
string
required

Unique identifier for the user

​
name
string
required

Name of the user

​
role
enum<string>

The role of the user within the customer.

Available options:
MEMBER,
MANAGER,
ADMIN
⌘I