Import customers

Understanding how to use FeatureOS API to build custom integrations.

Introduction

The FeatureOS import customers API allows you to import information about your customers. You can also import customers' associated data.

POST https://api.featureos.app/api/v3/customers/import

curl -X POST 'https://api.featureos.app/api/v3/customers/import' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/customers/import', {
  method: 'POST',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.post(
    'https://api.featureos.app/api/v3/customers/import',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.
Authorization	-	Generate a unique JWT token specific to a user.

Query Parameters

Parameter	Required	Format	Description
customers	true	Array	Array of customers to be imported. Follow the same format as the create customers API.

Sample Response

{
    "customers": [
        {
            "id": 9116912321,
            "name": "Developer",
            "email": "[email protected]",
            "blocked": false,
            "post_count": 1,
            "votes_count": 1,
            "comments_count": 2,
            "member_since": "about 1 year",
            "created_at": "2021-06-29T11:19:08.000Z",
            "starred": true,
            "labels": [
                "DEV ",
                "RUBY"
            ],
            "custom_fields": {},
            "profile_picture": null
        },
        {
            "id": 911691232123,
            "name": "Design",
            "email": "[email protected]",
            "blocked": false,
            "post_count": 6,
            "votes_count": 13,
            "comments_count": 3,
            "member_since": "about 1 year",
            "created_at": "2021-07-07T09:54:24.000Z",
            "starred": true,
            "labels": [],
            "custom_fields": {},
            "profile_picture": null
        }
    ],
    "errors": []
}