Set a bounded agent-facing preference.

PUT

/v1/virtual-users/{identity_id}/preferences/{key}

const url = 'https://app.everruns.com/api/v1/virtual-users/example/preferences/example';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"value":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://app.everruns.com/api/v1/virtual-users/example/preferences/example \
  --header 'Content-Type: application/json' \
  --data '{ "value": {} }'

Parameters

Path Parameters

identity_id

required

string

key

required

string

Request Body^required

application/json

Request body for setting a preference value.

object

value

required

object

Example^generated

{
  "value": {}
}

Responses

200

Success

application/json

Example^generated

example

401

Authentication required

403

Permission denied

Set a bounded agent-facing preference.

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

401

403

Request Body^required

Example^generated

Example^generated