Customers

Create or update customer

Create or update a customer.

If the customer with the specified email address already exists, the existing customer will be updated.

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

Customers accept arrays in custom_attributes.

Required scopes: write customers

post/api/v1/customers

Request

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

Request body

external_idstring
emailstring
namestring
companystring
languagestring
tagsstring[]
custom_attributesobject

Example request

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

Response

Successful response

idinteger
external_idstring
emailstring
namestring
tagsstring[]
custom_attributesobject
companystring
languagestring

Example response

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

Changes

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