curl --request PUT \
--url https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ControlParams": "{\"Options\":[\"Small\",\"Medium\",\"Large\",\"X-Large\"]}"
}
'import requests
url = "https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}"
payload = { "ControlParams": "{\"Options\":[\"Small\",\"Medium\",\"Large\",\"X-Large\"]}" }
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({ControlParams: '{"Options":["Small","Medium","Large","X-Large"]}'})
};
fetch('https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}', 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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}",
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([
'ControlParams' => '{"Options":["Small","Medium","Large","X-Large"]}'
]),
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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}"
payload := strings.NewReader("{\n \"ControlParams\": \"{\\\"Options\\\":[\\\"Small\\\",\\\"Medium\\\",\\\"Large\\\",\\\"X-Large\\\"]}\"\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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ControlParams\": \"{\\\"Options\\\":[\\\"Small\\\",\\\"Medium\\\",\\\"Large\\\",\\\"X-Large\\\"]}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}")
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 \"ControlParams\": \"{\\\"Options\\\":[\\\"Small\\\",\\\"Medium\\\",\\\"Large\\\",\\\"X-Large\\\"]}\"\n}"
response = http.request(request)
puts response.read_body{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"ControlType": "string",
"ControlParams": "string",
"Label": "string",
"SystemName": "string",
"EntityType": 0,
"Position": 0,
"Hidden": false
}{
"ErrorMessage": "string",
"EntityValidationErrors": [
{
"Entity": {},
"TypeName": "string",
"ValidationErrors": []
}
]
}Update a custom property of accounts, people or deals.
curl --request PUT \
--url https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ControlParams": "{\"Options\":[\"Small\",\"Medium\",\"Large\",\"X-Large\"]}"
}
'import requests
url = "https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}"
payload = { "ControlParams": "{\"Options\":[\"Small\",\"Medium\",\"Large\",\"X-Large\"]}" }
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({ControlParams: '{"Options":["Small","Medium","Large","X-Large"]}'})
};
fetch('https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}', 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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}",
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([
'ControlParams' => '{"Options":["Small","Medium","Large","X-Large"]}'
]),
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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}"
payload := strings.NewReader("{\n \"ControlParams\": \"{\\\"Options\\\":[\\\"Small\\\",\\\"Medium\\\",\\\"Large\\\",\\\"X-Large\\\"]}\"\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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ControlParams\": \"{\\\"Options\\\":[\\\"Small\\\",\\\"Medium\\\",\\\"Large\\\",\\\"X-Large\\\"]}\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions/{definitionUid}")
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 \"ControlParams\": \"{\\\"Options\\\":[\\\"Small\\\",\\\"Medium\\\",\\\"Large\\\",\\\"X-Large\\\"]}\"\n}"
response = http.request(request)
puts response.read_body{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"ControlType": "string",
"ControlParams": "string",
"Label": "string",
"SystemName": "string",
"EntityType": 0,
"Position": 0,
"Hidden": false
}{
"ErrorMessage": "string",
"EntityValidationErrors": [
{
"Entity": {},
"TypeName": "string",
"ValidationErrors": []
}
]
}Authorizations
Enter your access token (OAuth / JWT).
Path Parameters
The entity type the definition belongs to: Account, Person or Deal
The definition's unique identifier
Body
The fields to change
The fields of a custom property that an update may change. Every field is optional: a field left out keeps its current value.
The name of the property shown in Outseta. Unique among the entity type's custom properties, and not the label of a standard property. Cannot be null.
The name of the property in the API, webhooks and forms. Starts with a letter and holds only letters, numbers and _. Changing it keeps the stored values under the new name; anything that uses the old name has to be updated. Cannot be null.
^[A-Za-z][A-Za-z0-9_]*$The control used to fill in the property: Text, TextArea, Number, Date, Checkbox, Select, RadioList or CheckboxList. Cannot be null.
The control's settings: a JSON object serialized into a string, replaced as a whole. To add an option, send the full list, for example "{"Options":["Small","Medium","Large","X-Large"]}".
Response
11102500 - None, 1 - Account, 2 - Person, 3 - Deal, 4 - Case, 5 - Invoice, 6 - EmailLog, 7 - Plan, 8 - DiscountCoupon, 9 - AddOn, 10 - Task, 11 - Segment, 12 - Broadcast, 13 - Article
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13