Customers

Bulk upsert customers

Bulk upsert customers, creating or updating multiple customers at once.

Maximum 1000 customers per request.

Updating the custom_attributes or tags fields will overwrite any existing values.

Customers accept arrays in custom_attributes.

Customers with invalid data will be ignored.

Required scopes: write customers

post/api/v1/customers/bulk

Request

  • Base URL: https://api.simplesat.io
  • URL: https://api.simplesat.io/api/v1/customers/bulk
  • Auth: API key in header X-Simplesat-Token

Request body

Example request

{
  "customers": [
    {
      "external_id": 1,
      "email": "tester@simplesat.io",
      "name": "Tester McTestFace",
      "company": "Simplesat",
      "tags": [
        "tag1",
        "tag2"
      ],
      "custom_attributes": {
        "City": "San Francisco",
        "Channels": [
          "Web",
          "Mobile App"
        ],
        "Country": "United States"
      }
    }
  ]
}

Response

Successful response

request_idstring
detailstring

Example response

{
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "detail": "Customer(s) successfully scheduled to be updated or created."
}

Changes

No recorded changes to this operation across all 1 revision of this API.