POST
/
api
/
update_customer
/
curl --location --request POST 'https://api.explo.co/api/update_customer/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
    "provided_id": "example_1",
    "properties": {"filterValue": "new_value"},
    "emails": ["[email protected]"],
    "group_tags": ["engineers", "sales"],
    "hierarchy_level_name": "Level 1"
}'

{
  "success": 1,
  "customer": {
    "token": "<customer_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1",
    "is_demo_group": false,
    "emails": ["[email protected]"],
    "group_tags": ["engineers", "sales"],
    "properties": { "filterValue": "new_value" },
    "computed_properties": { "filterValue": "new_value" },
    "access_group": "Production",
    "parent_schema_datasource_mapping": {"40": "213": "134": 386"},
    "computed_parent_schema_datasource_mapping": {"40": "213": "134": 386"},
    "hierarchy_level": "Level 1"
  }
}

This endpoint updates an existing customer. Provided_id is required to request a customer, and only the other provided fields will be updated.

​
Body

provided_id
string

This is the ID you use to identify this customer in your database.

new_provided_id
string

Set this field if you’d like to change the ID used to identify the customer in the database. This will replace the current provided_id.

name
string | null

This is the name of the customer.

mapping
object | null

This is a JSON mapping of schema id to either the data source that this user group should be associated with.

is_demo_group
boolean | null

Set this boolean parameter to true to make data panels include a demo watermark for the customer. Demo customers do not count towards paid user groups. Default value is false.

properties
object | null

This is a JSON object for properties assigned to this customer. These will be accessible through variables in the dashboards and SQL editor

emails
string[] | null

This is an array of email addresses to add to the customer.

group_tags
string[] | null

An array of group tag names to assign to the customer. This will override previous group tag assignment if specified. Supplying the empty array will remove all group tags. Group tag names must be of existing group tags, and these can be created with the create_group_tag endpoint.

hierarchy_level_name
string | null

The name of the hierarchy level to assign to the customer. Must be an existing hierarchy level. This will override previous assignment. If you do not have a hierarchy set up and would like one, reach out to customer support.

parent_provided_id
object | null

This is an identifier for a parent customer matching the parent’s provided_id. If provided, the customer will be set as a child of the parent customer, and will have its computed_properties and computed_parent_schema_datasource_mapping fields inherit values from the parent customer. Note that parents must be at a strictly higher hierarchy level than their children. You can contact customer support to set up a hierarchy for your customers.

​
Response

success
number

Indicates whether the call was successful. 1 if successful, 0 if not.

customer
object

The contents of the customer

Get or CreateDelete