Update user
curl --request PUT \
--url https://functions.siro.ai/api-externalApi/v1/core/users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"phoneNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"memberTeamId": "<string>",
"disabled": true,
"billable": true,
"contactSettings": {
"suppressEmails": true,
"suppressEmailErrors": false
},
"organizationId": "<string>"
}
'import requests
url = "https://functions.siro.ai/api-externalApi/v1/core/users/{id}"
payload = {
"email": "<string>",
"phoneNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"memberTeamId": "<string>",
"disabled": True,
"billable": True,
"contactSettings": {
"suppressEmails": True,
"suppressEmailErrors": False
},
"organizationId": "<string>"
}
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({
email: '<string>',
phoneNumber: '<string>',
firstName: '<string>',
lastName: '<string>',
memberTeamId: '<string>',
disabled: true,
billable: true,
contactSettings: {suppressEmails: true, suppressEmailErrors: false},
organizationId: '<string>'
})
};
fetch('https://functions.siro.ai/api-externalApi/v1/core/users/{id}', 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://functions.siro.ai/api-externalApi/v1/core/users/{id}",
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([
'email' => '<string>',
'phoneNumber' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'memberTeamId' => '<string>',
'disabled' => true,
'billable' => true,
'contactSettings' => [
'suppressEmails' => true,
'suppressEmailErrors' => false
],
'organizationId' => '<string>'
]),
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://functions.siro.ai/api-externalApi/v1/core/users/{id}"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"memberTeamId\": \"<string>\",\n \"disabled\": true,\n \"billable\": true,\n \"contactSettings\": {\n \"suppressEmails\": true,\n \"suppressEmailErrors\": false\n },\n \"organizationId\": \"<string>\"\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://functions.siro.ai/api-externalApi/v1/core/users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"memberTeamId\": \"<string>\",\n \"disabled\": true,\n \"billable\": true,\n \"contactSettings\": {\n \"suppressEmails\": true,\n \"suppressEmailErrors\": false\n },\n \"organizationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://functions.siro.ai/api-externalApi/v1/core/users/{id}")
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 \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"memberTeamId\": \"<string>\",\n \"disabled\": true,\n \"billable\": true,\n \"contactSettings\": {\n \"suppressEmails\": true,\n \"suppressEmailErrors\": false\n },\n \"organizationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"email": "<string>",
"organizationId": "<string>",
"phoneNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"memberTeamId": "<string>",
"coachTeamIds": [
"<string>"
],
"externalId": "<string>",
"createdAt": "<string>",
"disabled": true,
"billable": true,
"contactSettings": {
"suppressEmails": true,
"suppressEmailErrors": false
}
}Users
Update user
Update user
PUT
/
v1
/
core
/
users
/
{id}
Update user
curl --request PUT \
--url https://functions.siro.ai/api-externalApi/v1/core/users/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"phoneNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"memberTeamId": "<string>",
"disabled": true,
"billable": true,
"contactSettings": {
"suppressEmails": true,
"suppressEmailErrors": false
},
"organizationId": "<string>"
}
'import requests
url = "https://functions.siro.ai/api-externalApi/v1/core/users/{id}"
payload = {
"email": "<string>",
"phoneNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"memberTeamId": "<string>",
"disabled": True,
"billable": True,
"contactSettings": {
"suppressEmails": True,
"suppressEmailErrors": False
},
"organizationId": "<string>"
}
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({
email: '<string>',
phoneNumber: '<string>',
firstName: '<string>',
lastName: '<string>',
memberTeamId: '<string>',
disabled: true,
billable: true,
contactSettings: {suppressEmails: true, suppressEmailErrors: false},
organizationId: '<string>'
})
};
fetch('https://functions.siro.ai/api-externalApi/v1/core/users/{id}', 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://functions.siro.ai/api-externalApi/v1/core/users/{id}",
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([
'email' => '<string>',
'phoneNumber' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'memberTeamId' => '<string>',
'disabled' => true,
'billable' => true,
'contactSettings' => [
'suppressEmails' => true,
'suppressEmailErrors' => false
],
'organizationId' => '<string>'
]),
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://functions.siro.ai/api-externalApi/v1/core/users/{id}"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"memberTeamId\": \"<string>\",\n \"disabled\": true,\n \"billable\": true,\n \"contactSettings\": {\n \"suppressEmails\": true,\n \"suppressEmailErrors\": false\n },\n \"organizationId\": \"<string>\"\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://functions.siro.ai/api-externalApi/v1/core/users/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"memberTeamId\": \"<string>\",\n \"disabled\": true,\n \"billable\": true,\n \"contactSettings\": {\n \"suppressEmails\": true,\n \"suppressEmailErrors\": false\n },\n \"organizationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://functions.siro.ai/api-externalApi/v1/core/users/{id}")
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 \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"memberTeamId\": \"<string>\",\n \"disabled\": true,\n \"billable\": true,\n \"contactSettings\": {\n \"suppressEmails\": true,\n \"suppressEmailErrors\": false\n },\n \"organizationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"email": "<string>",
"organizationId": "<string>",
"phoneNumber": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"memberTeamId": "<string>",
"coachTeamIds": [
"<string>"
],
"externalId": "<string>",
"createdAt": "<string>",
"disabled": true,
"billable": true,
"contactSettings": {
"suppressEmails": true,
"suppressEmailErrors": false
}
}Authorizations
Organization integration token from Siro admin (Person icon → API Tokens). Send Authorization: Bearer . This is not the OAuth access token used with api.siro.ai user-scoped endpoints.
Path Parameters
Body
application/json
The user's email
The user's phone number.
The user's first name.
The user's last name.
The 6 digit code for the user's team. Strongly suggested to add this.
This field is true for users who are no longer a part of your organization or no longer using Siro.
Whether the user is billable and should be included in the license count
Contact settings for the user
Show child attributes
Show child attributes
Organization ID of the user
Response
200 - application/json
Update user
Contact settings for the user
Show child attributes
Show child attributes
⌘I