Profile
Update user profile
Update the user profile details
PUT
/
api
/
v1
/
profile
Update user profile
curl --request PUT \
--url https://airys.chat/api/v1/profile \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"profile": {
"name": "<string>",
"email": "<string>",
"display_name": "<string>",
"message_signature": "<string>",
"phone_number": "<string>",
"current_password": "<string>",
"password": "<string>",
"password_confirmation": "<string>",
"ui_settings": {}
}
}
'import requests
url = "https://airys.chat/api/v1/profile"
payload = { "profile": {
"name": "<string>",
"email": "<string>",
"display_name": "<string>",
"message_signature": "<string>",
"phone_number": "<string>",
"current_password": "<string>",
"password": "<string>",
"password_confirmation": "<string>",
"ui_settings": {}
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
profile: {
name: '<string>',
email: '<string>',
display_name: '<string>',
message_signature: '<string>',
phone_number: '<string>',
current_password: '<string>',
password: '<string>',
password_confirmation: '<string>',
ui_settings: {}
}
})
};
fetch('https://airys.chat/api/v1/profile', 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://airys.chat/api/v1/profile",
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([
'profile' => [
'name' => '<string>',
'email' => '<string>',
'display_name' => '<string>',
'message_signature' => '<string>',
'phone_number' => '<string>',
'current_password' => '<string>',
'password' => '<string>',
'password_confirmation' => '<string>',
'ui_settings' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://airys.chat/api/v1/profile"
payload := strings.NewReader("{\n \"profile\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"display_name\": \"<string>\",\n \"message_signature\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"current_password\": \"<string>\",\n \"password\": \"<string>\",\n \"password_confirmation\": \"<string>\",\n \"ui_settings\": {}\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("api_access_token", "<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://airys.chat/api/v1/profile")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"profile\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"display_name\": \"<string>\",\n \"message_signature\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"current_password\": \"<string>\",\n \"password\": \"<string>\",\n \"password_confirmation\": \"<string>\",\n \"ui_settings\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://airys.chat/api/v1/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"display_name\": \"<string>\",\n \"message_signature\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"current_password\": \"<string>\",\n \"password\": \"<string>\",\n \"password_confirmation\": \"<string>\",\n \"ui_settings\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"access_token": "<string>",
"account_id": 123,
"available_name": "<string>",
"avatar_url": "<string>",
"confirmed": true,
"display_name": "<string>",
"message_signature": "<string>",
"email": "<string>",
"hmac_identifier": "<string>",
"inviter_id": 123,
"name": "<string>",
"provider": "<string>",
"pubsub_token": "<string>",
"ui_settings": {},
"uid": "<string>",
"type": "<string>",
"custom_attributes": {},
"accounts": [
{
"id": 123,
"name": "<string>",
"status": "<string>",
"active_at": "2023-11-07T05:31:56Z",
"permissions": [
"<string>"
],
"availability": "<string>",
"availability_status": "<string>",
"auto_offline": true,
"custom_role_id": 123,
"custom_role": {}
}
]
}Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Body
application/jsonmultipart/form-data
Show child attributes
Show child attributes
Response
Success
Available options:
agent, administrator Available for users who are created through platform APIs and has custom attributes associated.
Show child attributes
Show child attributes
⌘I
Update user profile
curl --request PUT \
--url https://airys.chat/api/v1/profile \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"profile": {
"name": "<string>",
"email": "<string>",
"display_name": "<string>",
"message_signature": "<string>",
"phone_number": "<string>",
"current_password": "<string>",
"password": "<string>",
"password_confirmation": "<string>",
"ui_settings": {}
}
}
'import requests
url = "https://airys.chat/api/v1/profile"
payload = { "profile": {
"name": "<string>",
"email": "<string>",
"display_name": "<string>",
"message_signature": "<string>",
"phone_number": "<string>",
"current_password": "<string>",
"password": "<string>",
"password_confirmation": "<string>",
"ui_settings": {}
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
profile: {
name: '<string>',
email: '<string>',
display_name: '<string>',
message_signature: '<string>',
phone_number: '<string>',
current_password: '<string>',
password: '<string>',
password_confirmation: '<string>',
ui_settings: {}
}
})
};
fetch('https://airys.chat/api/v1/profile', 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://airys.chat/api/v1/profile",
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([
'profile' => [
'name' => '<string>',
'email' => '<string>',
'display_name' => '<string>',
'message_signature' => '<string>',
'phone_number' => '<string>',
'current_password' => '<string>',
'password' => '<string>',
'password_confirmation' => '<string>',
'ui_settings' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <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://airys.chat/api/v1/profile"
payload := strings.NewReader("{\n \"profile\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"display_name\": \"<string>\",\n \"message_signature\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"current_password\": \"<string>\",\n \"password\": \"<string>\",\n \"password_confirmation\": \"<string>\",\n \"ui_settings\": {}\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("api_access_token", "<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://airys.chat/api/v1/profile")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"profile\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"display_name\": \"<string>\",\n \"message_signature\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"current_password\": \"<string>\",\n \"password\": \"<string>\",\n \"password_confirmation\": \"<string>\",\n \"ui_settings\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://airys.chat/api/v1/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"display_name\": \"<string>\",\n \"message_signature\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"current_password\": \"<string>\",\n \"password\": \"<string>\",\n \"password_confirmation\": \"<string>\",\n \"ui_settings\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"access_token": "<string>",
"account_id": 123,
"available_name": "<string>",
"avatar_url": "<string>",
"confirmed": true,
"display_name": "<string>",
"message_signature": "<string>",
"email": "<string>",
"hmac_identifier": "<string>",
"inviter_id": 123,
"name": "<string>",
"provider": "<string>",
"pubsub_token": "<string>",
"ui_settings": {},
"uid": "<string>",
"type": "<string>",
"custom_attributes": {},
"accounts": [
{
"id": 123,
"name": "<string>",
"status": "<string>",
"active_at": "2023-11-07T05:31:56Z",
"permissions": [
"<string>"
],
"availability": "<string>",
"availability_status": "<string>",
"auto_offline": true,
"custom_role_id": 123,
"custom_role": {}
}
]
}