Create Client

Creates a new client in InventoryBase.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

stringrequired

The client's full name.

stringrequired

The client's email address.

objectrequired

The client's primary address object.

string

The client's telephone number.

string

The client's company name.

string

The client's website.

string

Notes about the client.

boolean

Whether to send login details to the new client.

boolean

Whether the client should receive email notifications.

boolean

Whether to suppress the initial welcome email.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v1/universal/inventoryBase/0.0.7/actions/create-client" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "name": "",
  "email": "",
  "address": ""
}'

{
  "success": true,
  "data": [
    {
      "additionalEmails": [
        "[email protected]"
      ],
      "address": {
        "city": "string",
        "country": "string",
        "county": "string",
        "line1": "string",
        "line2": "string",
        "postcode": "string"
      },
      "billingEmail": "[email protected]",
      "company": "string",
      "companyNo": "string",
      "createdAt": "string",
      "customFields": {},
      "deletedAt": "string",
      "disabledTypes": [
        "string"
      ],
      "email": "[email protected]",
      "emailNotifications": true,
      "id": 1,
      "isAdminManager": true,
      "isManager": true,
      "isTypist": true,
      "loginEnabled": true,
      "logo": "string",
      "mobile": "string",
      "name": "Ava Chen",
      "notes": "string",
      "pendingEmail": "[email protected]",
      "role": 1,
      "settings": {},
      "signature": "string",
      "telephone": "string",
      "title": "string",
      "vatNo": "string",
      "website": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.