Import Customers

Imports existing customer records into Cheddar.

POST

Query

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

string

Comma-separated response fields to include.

Body

Arguments

stringrequired

Unique code for the customer in Cheddar.

stringrequired

Customer first name.

stringrequired

Customer last name.

stringrequired

Customer email address.

object

Subscription details for the imported customer.

stringrequired

Pricing plan code to subscribe the customer to.

string

Payment method: cc (default) or paypal.

string

Pre-tokenized payment method reference.

string

Promotion coupon code to apply.

Uncommon arguments

string

Client IPv4 address for fraud protection and rate limiting.

Try this request

Request

curl --request POST \
  --url "https://connect.mindcloud.co/v1/universal/cheddar/latest/actions/import-customers" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "code": "",
  "firstName": "",
  "lastName": "",
  "email": "",
  "subscription.planCode": ""
}'

{
  "success": true,
  "data": [
    {
      "customers": [
        {}
      ],
      "customers[]": {
        "code": "string",
        "company": "string",
        "createdDatetime": "2026-05-07T12:00:00.000Z",
        "email": "[email protected]",
        "firstName": "Ava",
        "gatewayToken": "string",
        "id": "string",
        "lastName": "Chen",
        "modifiedDatetime": "2026-05-07T12:00:00.000Z",
        "notes": "string",
        "subscriptions": [
          {}
        ],
        "subscriptions[]": {
          "canceledDatetime": "2026-05-07T12:00:00.000Z",
          "ccExpirationDate": "2026-05-07T12:00:00.000Z",
          "ccFirstName": "Ava",
          "ccLastFour": "string",
          "ccLastName": "Chen",
          "ccType": "string",
          "createdDatetime": "2026-05-07T12:00:00.000Z",
          "gatewayToken": "string",
          "id": "string",
          "invoices": [
            {}
          ],
          "invoices[]": {
            "billingDatetime": "2026-05-07T12:00:00.000Z",
            "charges": [
              {}
            ],
            "charges[]": {
              "code": "string",
              "description": "string",
              "eachAmount": 1,
              "id": "string",
              "quantity": 1
            },
            "createdDatetime": "2026-05-07T12:00:00.000Z",
            "id": "string",
            "number": "string",
            "transactions": [
              {}
            ],
            "transactions[]": {
              "amount": 1,
              "id": "string",
              "response": "string",
              "transactedDatetime": "2026-05-07T12:00:00.000Z"
            },
            "type": "string"
          },
          "plans": [
            {}
          ],
          "plans[]": {
            "code": "string",
            "description": "string",
            "id": "string",
            "isActive": true,
            "isFree": true,
            "name": "Ava Chen",
            "trialDays": 1
          }
        }
      }
    }
  ],
  "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.