curl --request PATCH \
--url 'https://api-prod.usefini.com/v2/users/me/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{"alias":"Support team"}'
const response = await fetch('https://api-prod.usefini.com/v2/users/me/public', {
method: 'PATCH',
headers: { Authorization: 'Bearer fini_your_api_key', 'Content-Type': 'application/json' },
body: JSON.stringify({"alias":"Support team"})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
import requests
response = requests.patch(
"https://api-prod.usefini.com/v2/users/me/public",
headers={"Authorization": "Bearer fini_your_api_key"},
json={"alias":"Support team"},
)
response.raise_for_status()
data = response.json()
{
"id": "22222222-2222-4222-8222-222222222222",
"email": "[email protected]",
"isOnboarded": true,
"avatarUrl": "https://example.com/avatar.png",
"fullName": "Example Agent",
"alias": "Support team"
}
Profile
Update my reply alias
Change the reply alias for the user associated with your API credential.
PATCH
/
v2
/
users
/
me
/
public
curl --request PATCH \
--url 'https://api-prod.usefini.com/v2/users/me/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{"alias":"Support team"}'
const response = await fetch('https://api-prod.usefini.com/v2/users/me/public', {
method: 'PATCH',
headers: { Authorization: 'Bearer fini_your_api_key', 'Content-Type': 'application/json' },
body: JSON.stringify({"alias":"Support team"})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
import requests
response = requests.patch(
"https://api-prod.usefini.com/v2/users/me/public",
headers={"Authorization": "Bearer fini_your_api_key"},
json={"alias":"Support team"},
)
response.raise_for_status()
data = response.json()
{
"id": "22222222-2222-4222-8222-222222222222",
"email": "[email protected]",
"isOnboarded": true,
"avatarUrl": "https://example.com/avatar.png",
"fullName": "Example Agent",
"alias": "Support team"
}
Updates the user associated with the API credential, not an arbitrary teammate. For a workspace API key, this is its associated creator identity. If that identity is absent, the request fails; you cannot supply a target user ID.
Only
alias is editable through this endpoint. It is trimmed and limited to 100 characters. Send null or a blank string to clear it. A body with no supported fields is rejected. This changes the user’s saved reply alias immediately.
Headers
string
required
Bearer token containing your Fini workspace API key. Format:
Bearer fini_... The key needs write scope.Body
string | null
required
Reply alias, up to 100 characters after trimming. Null clears the alias.
Response
string
Updated user ID.
string | null
Trimmed reply alias, or null after clearing.
string
User’s full name; unchanged by this endpoint.
string
User’s account email; unchanged by this endpoint.
curl --request PATCH \
--url 'https://api-prod.usefini.com/v2/users/me/public' \
--header 'Authorization: Bearer fini_your_api_key' \
--header 'Content-Type: application/json' \
--data '{"alias":"Support team"}'
const response = await fetch('https://api-prod.usefini.com/v2/users/me/public', {
method: 'PATCH',
headers: { Authorization: 'Bearer fini_your_api_key', 'Content-Type': 'application/json' },
body: JSON.stringify({"alias":"Support team"})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
import requests
response = requests.patch(
"https://api-prod.usefini.com/v2/users/me/public",
headers={"Authorization": "Bearer fini_your_api_key"},
json={"alias":"Support team"},
)
response.raise_for_status()
data = response.json()
{
"id": "22222222-2222-4222-8222-222222222222",
"email": "[email protected]",
"isOnboarded": true,
"avatarUrl": "https://example.com/avatar.png",
"fullName": "Example Agent",
"alias": "Support team"
}
Errors
400 for an absent associated user, an empty update, a non-string/non-null alias, or an alias longer than 100 characters. All requests can return 401 for an invalid or revoked key, or 403 when the required scope is missing.Was this page helpful?