curl --request PUT \
--url https://app.omnivibe.com.br/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": {}
}
}
'{
"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>",
"role": "agent",
"ui_settings": {},
"uid": "<string>",
"type": "<string>",
"custom_attributes": {},
"accounts": [
{
"id": 123,
"name": "<string>",
"status": "<string>",
"active_at": "2023-11-07T05:31:56Z",
"role": "administrator",
"permissions": [
"<string>"
],
"availability": "<string>",
"availability_status": "<string>",
"auto_offline": true,
"custom_role_id": 123,
"custom_role": {}
}
]
}Update the user profile details
curl --request PUT \
--url https://app.omnivibe.com.br/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": {}
}
}
'{
"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>",
"role": "agent",
"ui_settings": {},
"uid": "<string>",
"type": "<string>",
"custom_attributes": {},
"accounts": [
{
"id": 123,
"name": "<string>",
"status": "<string>",
"active_at": "2023-11-07T05:31:56Z",
"role": "administrator",
"permissions": [
"<string>"
],
"availability": "<string>",
"availability_status": "<string>",
"auto_offline": true,
"custom_role_id": 123,
"custom_role": {}
}
]
}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.
Show child attributes
Success
agent, administrator Available for users who are created through platform APIs and has custom attributes associated.
Show child attributes
Was this page helpful?