Skip to main content
POST
/
businesses
/
me
/
users
Add a user to the current business account
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",
  "licenseBillingStatus": "<string>",
  "licenseStripeSubscriptionId": "<string>",
  "licenseStripeSubscriptionItemId": "<string>",
  "licenseQuantity": "<string>",
  "licenseRenewalDate": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Body

The user and role to add to the current business.

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>

The role value for this business user.

Available options:
Owner,
Admin,
Agent

Response

Returns the business user response.

API response containing business user data returned to callers.

​
business
object

The business value for this business user.

​
user
object

The user value for this business user.

​
userEmail
string | null

The user email value for this business user.

​
role
enum<string>

The role value for this business user.

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.

​
licenseBillingStatus
string | null

The billing status for this user's business license.

​
licenseStripeSubscriptionId
string | null

The Stripe subscription ID containing this user's business license item.

​
licenseStripeSubscriptionItemId
string | null

The Stripe subscription item ID used for business user licenses.

​
licenseQuantity
string<int64> | null

The quantity on the shared business user license item after this change.

Pattern: ^-?(?:0|[1-9]\d*)$
​
licenseRenewalDate
string<date-time> | null

The renewal date used for this user's license proration.

​
name
string

The display name for the entity.

​
id
string

The unique identifier for the entity.

​
createdAt
string<date-time>

The date and time when the entity was created.

​
modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.