Update a user
curl --request PUT \
--url https://api.synci.io/managed/v1/users/{userId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"external_user_id": "<string>",
"connection_limit": 10
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({external_user_id: '<string>', connection_limit: 10})
};
fetch('https://api.synci.io/managed/v1/users/{userId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.synci.io/managed/v1/users/{userId}"
payload = {
"external_user_id": "<string>",
"connection_limit": 10
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synci.io/managed/v1/users/{userId}",
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([
'external_user_id' => '<string>',
'connection_limit' => 10
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://api.synci.io/managed/v1/users/{userId}"
payload := strings.NewReader("{\n \"external_user_id\": \"<string>\",\n \"connection_limit\": 10\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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))
}{
"data": {
"user_id": "<string>",
"external_user_id": "<string>",
"email": "<string>",
"email_verified": true,
"onboarded_at": "<string>",
"limits": {
"financial_connections": "<string>"
},
"created_at": "<string>",
"connections_count": 123
}
}{
"message": "<string>",
"errors": {}
}Update a user
Changes your correlation id or their connection allowance. The email address is not editable — it is the credential they sign in with.
PUT
/
users
/
{userId}
Update a user
curl --request PUT \
--url https://api.synci.io/managed/v1/users/{userId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"external_user_id": "<string>",
"connection_limit": 10
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({external_user_id: '<string>', connection_limit: 10})
};
fetch('https://api.synci.io/managed/v1/users/{userId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.synci.io/managed/v1/users/{userId}"
payload = {
"external_user_id": "<string>",
"connection_limit": 10
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synci.io/managed/v1/users/{userId}",
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([
'external_user_id' => '<string>',
'connection_limit' => 10
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://api.synci.io/managed/v1/users/{userId}"
payload := strings.NewReader("{\n \"external_user_id\": \"<string>\",\n \"connection_limit\": 10\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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))
}{
"data": {
"user_id": "<string>",
"external_user_id": "<string>",
"email": "<string>",
"email_verified": true,
"onboarded_at": "<string>",
"limits": {
"financial_connections": "<string>"
},
"created_at": "<string>",
"connections_count": 123
}
}{
"message": "<string>",
"errors": {}
}Authorizations
Username = your client id. Password = your client secret.
So the base64-encoded username:password described below is
client_id:client_secret:
Authorization: Basic base64(YOUR_CLIENT_ID:YOUR_CLIENT_SECRET)
Most HTTP clients build that header for you:
curl -u "YOUR_CLIENT_ID:YOUR_CLIENT_SECRET" \
https://api.synci.io/managed/v1/users
Both values come from Developers → Apps → your app. The
secret is shown once at creation and is prefixed oac_.
Path Parameters
Body
application/json
Your own identifier for this user. Unique within your app.
Maximum string length:
255How many financial connections this user may create: bank, brokerage and crypto-exchange alike. Null resets to your app's default.
Required range:
0 <= x <= 20Response
ManagedUserResource
Show child attributes
Show child attributes