Create a customer

POST/api/customers

Creates a customer record with standard and custom customer fields.

Request Body

application/json

Request payload for Create a customer.

type*string

Customer type classification.

Value in"individual" | "company"

Example"company"

name?|

Customer name.

email?|

Primary customer email.

phone?|

Primary phone number.

address?|

Primary address.

website?|

Customer website URL.

country?|

Country code or label.

idType?|

Government or tax identifier type.

idValue?|

Government or tax identifier value.

note?|

Internal note about the customer.

addresses?array<>|

Additional customer addresses.

customFields?|

Custom field values to persist on the customer.

memberships?array<>|

Customer-contact memberships to create or update with the customer.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/customers" \  -H "Content-Type: application/json" \  -d '{    "type": "company"  }'

{
  "id": "cust_123",
  "type": "company",
  "name": "Acme Corp",
  "email": "sales@acme.test",
  "phone": "+56 9 1234 5678",
  "address": "Av. Apoquindo 1234, Santiago",
  "website": "https://acme.test",
  "country": "CL",
  "idType": "RUT",
  "idValue": "76.123.456-7",
  "note": "Main distributor for the north region.",
  "addresses": [
    "Warehouse 2, Quilicura"
  ],
  "customFields": {
    "industry": "Construction",
    "tier": "gold"
  },
  "memberships": [
    {
      "id": "cm_123",
      "customerId": "cust_123",
      "personId": "person_123",
      "roles": [
        "buyer"
      ],
      "isPrimary": true,
      "isActive": true,
      "label": "Billing contact",
      "person": {
        "id": "person_123",
        "name": "Ana Torres",
        "primaryEmail": "ana@example.com",
        "emailAddresses": [
          "ana.work@example.com"
        ],
        "phoneNumbers": [
          "+56 9 1234 5678"
        ],
        "jobTitle": "Purchasing Manager"
      }
    }
  ],
  "primaryMembership": {
    "id": "cm_123",
    "customerId": "cust_123",
    "personId": "person_123",
    "roles": [
      "buyer"
    ],
    "isPrimary": true,
    "isActive": true,
    "label": "Billing contact",
    "person": {
      "id": "person_123",
      "name": "Ana Torres",
      "primaryEmail": "ana@example.com",
      "emailAddresses": [
        "ana.work@example.com"
      ],
      "phoneNumbers": [
        "+56 9 1234 5678"
      ],
      "jobTitle": "Purchasing Manager"
    }
  },
  "access": {
    "level": "limited",
    "readFields": [
      "name",
      "idValue",
      "customFields.sapCardCode"
    ],
    "writeFields": [],
    "relations": []
  }
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`