PUT

/v1/vendors/:id

Bearer*

Body

name
string

This is the name of the user group.

user_group_id
string

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

mapping
object

This is a JSON mapping of schema id to either the data source that this user group should be associated with or id of the datasource you provided when creating it.

properties
object

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

Response

success
number

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

user_group
object

The contents of the user group

curl --location --request PUT 'https://api.stateset.com/v1/vendor' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'
{
  "success": 1,
  "user_group": {
    "team_id": 113,
    "token": "<user_group_token_to_auth_dashboard>",
    "name": "ok",
    "provided_id": "6"
  }
}