Switch an attribute value for the current user

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/user-attribute-selections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "values": [
    "globex"
  ]
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/user-attribute-selections"

payload = {
    "user_attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "values": ["globex"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_attribute_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', values: ['globex']})
};

fetch('https://{instance}.omniapp.co/api/v1/user-attribute-selections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/user-attribute-selections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'user_attribute_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'values' => [
        'globex'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/user-attribute-selections"

	payload := strings.NewReader("{\n  \"user_attribute_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"values\": [\n    \"globex\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{instance}.omniapp.co/api/v1/user-attribute-selections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_attribute_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"values\": [\n    \"globex\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/user-attribute-selections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_attribute_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"values\": [\n    \"globex\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "records": [
    {
      "user_attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "client",
      "label": "Client",
      "multiple_values": false,
      "allow_any_value": false,
      "selectable_values": [
        "acme",
        "globex",
        "initech"
      ],
      "selected_values": [
        "globex"
      ]
    }
  ]
}

PUT

user-attribute-selections

Switch an attribute value for the current user

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/user-attribute-selections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "values": [
    "globex"
  ]
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/user-attribute-selections"

payload = {
    "user_attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "values": ["globex"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_attribute_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', values: ['globex']})
};

fetch('https://{instance}.omniapp.co/api/v1/user-attribute-selections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.omniapp.co/api/v1/user-attribute-selections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'user_attribute_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'values' => [
        'globex'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.omniapp.co/api/v1/user-attribute-selections"

	payload := strings.NewReader("{\n  \"user_attribute_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"values\": [\n    \"globex\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{instance}.omniapp.co/api/v1/user-attribute-selections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_attribute_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"values\": [\n    \"globex\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/user-attribute-selections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_attribute_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"values\": [\n    \"globex\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "records": [
    {
      "user_attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "client",
      "label": "Client",
      "multiple_values": false,
      "allow_any_value": false,
      "selectable_values": [
        "acme",
        "globex",
        "initech"
      ],
      "selected_values": [
        "globex"
      ]
    }
  ]
}

Allowed values

The calling user can only successfully switch if values are already provisioned, either by listing them in selectable_values or enabling allow_any_value. A single-valued attribute accepts exactly one value. A multi-valued attribute accepts any subset of up to 300 values.

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json

user_attribute_id

string

required

The user attribute definition to switch.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

values

string[]

required

Values this user or group can switch the attribute to, validated against the attribute type.

Numbers are sent as strings to preserve precision beyond 2^53. At most 300 values of up to 512 characters each.

Maximum array length: 300

Required string length: 1 - 512

Example:

["acme", "globex"]

Response

The caller's switchable attributes after the change

records

object[]

required

Attributes the calling user can switch. Empty when nothing is provisioned for them. An Organization Admin receives every attribute with allow_any_value: true.

Show child attributes

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Branch APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Switch an attribute value for the current user

Allowed values

Authorizations

Body

Response