Add customers

Add a new customer to your FeatureOS organization.

Introduction

The FeatureOS add customers API allows you to add customers to your organization. You can also add customers' associated data.

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

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

const response = await fetch('https://api.featureos.app/api/v3/customers', {
  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',
    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
name	false	String	Name of the customer
email	true	Email	Valid email ID of the customer
profile_picture_url	false	String	URL of the profile picture of the customer. Supports PNG, JPG, JPEG and GIF formats.
labels	false	Array	Array of labels to be added to the customer.
starred	false	Boolean	Set to true to star the customer.

Sample Response

{
  "id": 9116912321,
  "name": "Developer",
  "email": "developer@featureos.app",
  "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
}