Customer upload

Import customer data into Customerscore via the Customers API endpoint.

For interactive API documentation, see the Swagger reference (opens in a new tab).

Endpoint

Request Body

The customers field is mandatory in the JSON body. Each customer object within the customers array must include the following attributes:

Example Request

curl -X POST "https://api.customerscore.io/api/v1/customers" \
  -H "Content-Type: application/json" \
  -H "customerscore-key: your-generated-key" \
  -d '{
    "customers": [
      {
        "external_id": "12345",
        "name": "Knapp-Cruz Inc.",
        "owner_email": "owner@example.com",
        "attributes": {
          "crm_link": "https://your-crm.com/12345",
          "contact_email": "contact@example.com",
          "renewal_date": "2025-05-25"
        },
        "metrics": [
          {
            "date": "2024-04-29",
            "resolved_tickets": 39
          }
        ]
      }
    ]
  }'

Full Request Body Example

{
  "customers": [
    {
      "external_id": "12345",
      "name": "Knapp-Cruz Inc.",
      "owner_email": "owner@example.com",
      "attributes": {
        "crm_link": "https://example.com",
        "contact_email": "example@example.com",
        "renewal_date": "2024-05-25",
        "country_name": "Czech Republic",
        "customers_count": 99,
        "has_avatar": true
      },
      "metrics": [
        {
          "date": "2024-04-29",
          "country": "Czechia",
          "has_picture": true,
          "resolved_tickets": 39,
          "created_at": "2024-08-15"
        }
      ]
    }
  ]
}

Owner Email Field

If owner_email is provided, the customer will be automatically linked to the user in your account (if such a user exists).

Attributes Field

The attributes field is an object that contains useful information about a given customer. You can add:

• System attributes: crm_link, contact_email, renewal_date
• Custom attributes: Configured in the Customerscore.io application under Attributes (opens in a new tab)

Example Attributes Object

{
  "crm_link": "https://your-crm-link.com/12345",
  "contact_email": "example@example.com",
  "renewal_date": "2025-05-25",
  "country_name": "Czech Republic",
  "customers_count": 99,
  "has_avatar": true
}

Supported Value Types

Metrics Field

The metrics field contains product-usage data that feeds into the health score calculation. It can hold up to 200 items.

Example Metrics Array

[
  {
    "date": "2024-04-29",
    "country": "Czechia",
    "has_picture": true,
    "resolved_tickets": 39,
    "created_at": "2024-08-15"
  }
]

Processing

Upon successful data import, internal processing will occur, including a scoring process that may take up to 30 minutes. After processing is complete, all users in the account will receive a notification regarding the newly imported customer data.

Response Codes