cURL
curl --request PATCH \
--url https://app-api.aide.app/v1/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"phoneNumber": "<string>",
"avatarUrl": "<string>",
"signature": "<string>",
"emailPreferences": {},
"currentPassword": "<string>",
"password": "<string>"
}
'import requests
url = "https://app-api.aide.app/v1/me"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"phoneNumber": "<string>",
"avatarUrl": "<string>",
"signature": "<string>",
"emailPreferences": {},
"currentPassword": "<string>",
"password": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
jobTitle: '<string>',
phoneNumber: '<string>',
avatarUrl: '<string>',
signature: '<string>',
emailPreferences: {},
currentPassword: '<string>',
password: '<string>'
})
};
fetch('https://app-api.aide.app/v1/me', 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://app-api.aide.app/v1/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => '<string>',
'lastName' => '<string>',
'jobTitle' => '<string>',
'phoneNumber' => '<string>',
'avatarUrl' => '<string>',
'signature' => '<string>',
'emailPreferences' => [
],
'currentPassword' => '<string>',
'password' => '<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://app-api.aide.app/v1/me"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"signature\": \"<string>\",\n \"emailPreferences\": {},\n \"currentPassword\": \"<string>\",\n \"password\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app-api.aide.app/v1/me")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"signature\": \"<string>\",\n \"emailPreferences\": {},\n \"currentPassword\": \"<string>\",\n \"password\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app-api.aide.app/v1/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"signature\": \"<string>\",\n \"emailPreferences\": {},\n \"currentPassword\": \"<string>\",\n \"password\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"object": "me",
"accounts": [
{
"name": "<string>",
"id": "<string>",
"role": "admin"
}
],
"account": {
"name": "<string>",
"id": "<string>",
"exploreStatus": "<string>",
"isApproved": true,
"onboarding": {
"signupContext": {
"plan": "pro",
"stack": "chat_agent",
"utmSource": "<string>",
"utmMedium": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmTerm": "<string>",
"ref": "<string>"
},
"show": true,
"stage": 123,
"intentSlugs": [
"<string>"
],
"dismissedActions": [
"<string>"
]
},
"teamSize": "<string>",
"ticketsPerMonth": "<string>",
"website": "<string>"
},
"user": {
"email": "<string>",
"name": "<string>",
"createdAt": "<string>",
"id": "<string>",
"avatarUrl": "<string>",
"emailPreferences": {},
"firstName": "<string>",
"jobTitle": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"initials": "<string>"
},
"membership": {
"role": "admin",
"signature": "<string>",
"availability": {
"object": "availability",
"status": "available",
"until": "<string>",
"reason": "<string>",
"reassignOnAway": true,
"changedAt": "<string>"
},
"availabilityStatus": "available"
},
"flags": {
"hasTickets": true,
"hasPreviewed": true,
"hasTopics": true,
"hasWorkflows": true,
"hasKnowledge": true,
"hasAgent": true,
"hasHelpdeskIntegration": true,
"hasChannel": true,
"widgetFirstSeenAt": "<string>",
"widgetFirstSeenOrigin": "<string>",
"widgetBlockedOrigin": {
"lastSeenAt": "<string>",
"origin": "<string>"
},
"firstAiOutput": {
"at": "<string>",
"conversationId": "<string>",
"kind": "draft",
"helpdeskUrl": "<string>"
},
"emailForwarding": "none",
"billing": {
"status": "active",
"planSlug": "enterprise",
"trialEndsAt": "<string>",
"currentPeriodStart": "<string>",
"currentPeriodEnd": "<string>",
"cancelAtPeriodEnd": true,
"graceEndsAt": "<string>",
"aiPausedReason": "free_limit"
}
}
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}Account
Patch v1me
PATCH
/
v1
/
me
cURL
curl --request PATCH \
--url https://app-api.aide.app/v1/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"phoneNumber": "<string>",
"avatarUrl": "<string>",
"signature": "<string>",
"emailPreferences": {},
"currentPassword": "<string>",
"password": "<string>"
}
'import requests
url = "https://app-api.aide.app/v1/me"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"jobTitle": "<string>",
"phoneNumber": "<string>",
"avatarUrl": "<string>",
"signature": "<string>",
"emailPreferences": {},
"currentPassword": "<string>",
"password": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
jobTitle: '<string>',
phoneNumber: '<string>',
avatarUrl: '<string>',
signature: '<string>',
emailPreferences: {},
currentPassword: '<string>',
password: '<string>'
})
};
fetch('https://app-api.aide.app/v1/me', 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://app-api.aide.app/v1/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => '<string>',
'lastName' => '<string>',
'jobTitle' => '<string>',
'phoneNumber' => '<string>',
'avatarUrl' => '<string>',
'signature' => '<string>',
'emailPreferences' => [
],
'currentPassword' => '<string>',
'password' => '<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://app-api.aide.app/v1/me"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"signature\": \"<string>\",\n \"emailPreferences\": {},\n \"currentPassword\": \"<string>\",\n \"password\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app-api.aide.app/v1/me")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"signature\": \"<string>\",\n \"emailPreferences\": {},\n \"currentPassword\": \"<string>\",\n \"password\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app-api.aide.app/v1/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"jobTitle\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"signature\": \"<string>\",\n \"emailPreferences\": {},\n \"currentPassword\": \"<string>\",\n \"password\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"object": "me",
"accounts": [
{
"name": "<string>",
"id": "<string>",
"role": "admin"
}
],
"account": {
"name": "<string>",
"id": "<string>",
"exploreStatus": "<string>",
"isApproved": true,
"onboarding": {
"signupContext": {
"plan": "pro",
"stack": "chat_agent",
"utmSource": "<string>",
"utmMedium": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmTerm": "<string>",
"ref": "<string>"
},
"show": true,
"stage": 123,
"intentSlugs": [
"<string>"
],
"dismissedActions": [
"<string>"
]
},
"teamSize": "<string>",
"ticketsPerMonth": "<string>",
"website": "<string>"
},
"user": {
"email": "<string>",
"name": "<string>",
"createdAt": "<string>",
"id": "<string>",
"avatarUrl": "<string>",
"emailPreferences": {},
"firstName": "<string>",
"jobTitle": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"initials": "<string>"
},
"membership": {
"role": "admin",
"signature": "<string>",
"availability": {
"object": "availability",
"status": "available",
"until": "<string>",
"reason": "<string>",
"reassignOnAway": true,
"changedAt": "<string>"
},
"availabilityStatus": "available"
},
"flags": {
"hasTickets": true,
"hasPreviewed": true,
"hasTopics": true,
"hasWorkflows": true,
"hasKnowledge": true,
"hasAgent": true,
"hasHelpdeskIntegration": true,
"hasChannel": true,
"widgetFirstSeenAt": "<string>",
"widgetFirstSeenOrigin": "<string>",
"widgetBlockedOrigin": {
"lastSeenAt": "<string>",
"origin": "<string>"
},
"firstAiOutput": {
"at": "<string>",
"conversationId": "<string>",
"kind": "draft",
"helpdeskUrl": "<string>"
},
"emailForwarding": "none",
"billing": {
"status": "active",
"planSlug": "enterprise",
"trialEndsAt": "<string>",
"currentPeriodStart": "<string>",
"currentPeriodEnd": "<string>",
"cancelAtPeriodEnd": true,
"graceEndsAt": "<string>",
"aiPausedReason": "free_limit"
}
}
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"type": "api_error",
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"fields": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}Authorizations
An access token, bound to one account.
Body
application/json
Required string length:
1 - 60Required string length:
1 - 60Maximum string length:
120Maximum string length:
40Maximum string length:
2048Maximum string length:
5000Show child attributes
Show child attributes
Maximum string length:
72Required string length:
8 - 72Response
OK
Show child attributes
Show child attributes