Update customers

Understanding how to use FeatureOS API to build custom integrations.

Introduction

The FeatureOS update customers API allows you to update information about your customers by their email address.

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

curl -X PUT '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: 'PUT',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.put(
    '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	Format	Required	Description
email	String	true	Customer's email address
name	String	true	Customer's name
blocked	Boolean	false	Block the customer from accessing the organization
profile_picture_url	String	false	URL of the profile picture of the customer. Supports PNG, JPG, JPEG and GIF formats.
labels	Array	false	Array of labels to be added to the customer.
starred	Boolean	false	Set to true to star the customer.
custom_fields	JSON Object	false	Each field should be a key-value pair. To update an attribute, please provide the complete set of Key-Value pairs in the existing data, rather than only the specific attribute you wish to modify. This ensures that all necessary information is available for a successful update.

Sample Response

{
  "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": {
    "kind": "Vendor"
  },
  "profile_picture": null
}