Skip to main content
POST
/
businesses
/
me
/
users
Adds a user to the authenticated user's current business.
curl --request POST \
  --url https://api.leadping.ai/businesses/me/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "<string>",
  "email": "<string>"
}
'
{
  "business": {
    "id": "<string>",
    "name": "<string>"
  },
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "userEmail": "<string>",
  "createdByUserId": "<string>",
  "removedAt": "2023-11-07T05:31:56Z",
  "removedByUserId": "<string>",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://leadping.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Body

A token to cancel the operation.

Request payload for business user.

userId
string | null

The user ID associated with this business user.

email
string | null

The email address associated with this business user.

role
enum<string>

Defines the supported Business User Role values.

Available options:
Owner,
Admin,
Agent

Response

Returns the business user response.

API response containing business user data returned to callers.

business
object
user
object
userEmail
string | null

The user email value for this business user.

role
enum<string>

Defines the supported Business User Role values.

Available options:
Owner,
Admin,
Agent
createdByUserId
string | null

The created by user ID associated with this business user.

removedAt
string<date-time> | null

The date and time for the removed at value on this business user.

removedByUserId
string | null

The removed by user ID associated with this business user.

lastUsedAt
string<date-time> | null

The date and time for the last used at value on this business user.

name
string
id
string
createdAt
string<date-time>
modifiedAt
string<date-time> | null