Create a user-level counterparty category personalization
curl --request PUT \
--url https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
"categoryId": "011-000-000-000"
}
'import requests
url = "https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations"
payload = {
"counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
"categoryId": "011-000-000-000"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
counterpartyId: 'd730906b-f1a8-49f1-9939-f27390170a6d',
categoryId: '011-000-000-000'
})
};
fetch('https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations', 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://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations",
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([
'counterpartyId' => 'd730906b-f1a8-49f1-9939-f27390170a6d',
'categoryId' => '011-000-000-000'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations"
payload := strings.NewReader("{\n \"counterpartyId\": \"d730906b-f1a8-49f1-9939-f27390170a6d\",\n \"categoryId\": \"011-000-000-000\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"counterpartyId\": \"d730906b-f1a8-49f1-9939-f27390170a6d\",\n \"categoryId\": \"011-000-000-000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"counterpartyId\": \"d730906b-f1a8-49f1-9939-f27390170a6d\",\n \"categoryId\": \"011-000-000-000\"\n}"
response = http.request(request)
puts response.read_body{
"counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
"categoryId": "011-000-000-000",
"userId": "user1234"
}{
"counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
"categoryId": "011-000-000-000",
"userId": "user1234"
}{
"invalidField": [
"This field is required."
]
}{
"details": "Incorrect authentication credentials."
}{
"details": "Internal server error."
}Category Personalization
Create a user-level counterparty category personalization
Create a user-level counterparty category personalization.
This personalization will apply to all enrichments that take place at the given counterpartyId for the user with the given userId.
To learn more about user category personalization, please read the User Category Personalization Guide.
PUT
/
users
/
{userId}
/
counterparty-category-personalizations
Create a user-level counterparty category personalization
curl --request PUT \
--url https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
"categoryId": "011-000-000-000"
}
'import requests
url = "https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations"
payload = {
"counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
"categoryId": "011-000-000-000"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
counterpartyId: 'd730906b-f1a8-49f1-9939-f27390170a6d',
categoryId: '011-000-000-000'
})
};
fetch('https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations', 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://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations",
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([
'counterpartyId' => 'd730906b-f1a8-49f1-9939-f27390170a6d',
'categoryId' => '011-000-000-000'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$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://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations"
payload := strings.NewReader("{\n \"counterpartyId\": \"d730906b-f1a8-49f1-9939-f27390170a6d\",\n \"categoryId\": \"011-000-000-000\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
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://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"counterpartyId\": \"d730906b-f1a8-49f1-9939-f27390170a6d\",\n \"categoryId\": \"011-000-000-000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://east.sandbox.spade.com/users/{userId}/counterparty-category-personalizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"counterpartyId\": \"d730906b-f1a8-49f1-9939-f27390170a6d\",\n \"categoryId\": \"011-000-000-000\"\n}"
response = http.request(request)
puts response.read_body{
"counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
"categoryId": "011-000-000-000",
"userId": "user1234"
}{
"counterpartyId": "d730906b-f1a8-49f1-9939-f27390170a6d",
"categoryId": "011-000-000-000",
"userId": "user1234"
}{
"invalidField": [
"This field is required."
]
}{
"details": "Incorrect authentication credentials."
}{
"details": "Internal server error."
}Body
application/json
Schema for creating a counterparty category personalization.
Response
Updated
The newly created counterparty category personalization.

