API Documentation

Profile

Use profile APIs to read and update the connected account name, status text, and picture. The session must belong to the API key account and should be connected before calling these endpoints.

Common rules

Authentication

Send Authorization: Bearer YOUR_API_KEY with every request.

Session path

Use a dashboard session ID or session name such as {session}.

Picture input

The file object must include either url or data.

Endpoints

Method Endpoint Purpose
GET https://chatflow.zeltacode.com/api/v1/profile/{session} Return the current profile data for a connected session.
PUT https://chatflow.zeltacode.com/api/v1/profile/{session}/name Change the display name for the connected account.
PUT https://chatflow.zeltacode.com/api/v1/profile/{session}/status Change the profile status/about text for the connected account.
PUT https://chatflow.zeltacode.com/api/v1/profile/{session}/picture Upload a profile picture using a public image URL or encoded image data.
DELETE https://chatflow.zeltacode.com/api/v1/profile/{session}/picture Remove the current profile picture from the connected account.

1. Get profile

Return the current profile data for a connected session.

API name

Get profile

Purpose

Return the current profile data for a connected session. Use this when your application needs to manage the connected account profile from your own product.

Endpoint

GET https://chatflow.zeltacode.com/api/v1/profile/{session}

Replace {session} with a session ID or session name.

curl 
curl -X GET "https://chatflow.zeltacode.com/api/v1/profile/{session}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Example response 
{
    "success": true,
    "message": "Profile action completed.",
    "data": {
        "action": "get",
        "session": "{session}",
        "profile_response": {
            "id": "{number}@c.us",
            "name": "ChatFlow Test",
            "picture": "https://example.com/profile.jpg",
            "status": "Available"
        }
    }
}

2. Update profile name

Change the display name for the connected account.

API name

Update profile name

Purpose

Change the display name for the connected account. Use this when your application needs to manage the connected account profile from your own product.

Endpoint

PUT https://chatflow.zeltacode.com/api/v1/profile/{session}/name

Replace {session} with a session ID or session name.

curl 
curl -X PUT "https://chatflow.zeltacode.com/api/v1/profile/{session}/name" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ChatFlow Test"
}'
JSON body 
{
    "name": "ChatFlow Test"
}
Example response 
{
    "success": true,
    "message": "Profile action completed.",
    "data": {
        "action": "update-name",
        "session": "{session}",
        "profile_response": {}
    }
}

3. Update profile status

Change the profile status/about text for the connected account.

API name

Update profile status

Purpose

Change the profile status/about text for the connected account. Use this when your application needs to manage the connected account profile from your own product.

Endpoint

PUT https://chatflow.zeltacode.com/api/v1/profile/{session}/status

Replace {session} with a session ID or session name.

curl 
curl -X PUT "https://chatflow.zeltacode.com/api/v1/profile/{session}/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "Available for support"
}'
JSON body 
{
    "status": "Available for support"
}
Example response 
{
    "success": true,
    "message": "Profile action completed.",
    "data": {
        "action": "update-status",
        "session": "{session}",
        "profile_response": {}
    }
}

4. Update profile picture

Upload a profile picture using a public image URL or encoded image data.

API name

Update profile picture

Purpose

Upload a profile picture using a public image URL or encoded image data. Use this when your application needs to manage the connected account profile from your own product.

Endpoint

PUT https://chatflow.zeltacode.com/api/v1/profile/{session}/picture

Replace {session} with a session ID or session name.

curl 
curl -X PUT "https://chatflow.zeltacode.com/api/v1/profile/{session}/picture" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "file": {
        "url": "https://picsum.photos/600/600",
        "mimetype": "image/jpeg",
        "filename": "profile.jpg"
    }
}'
JSON body 
{
    "file": {
        "url": "https://picsum.photos/600/600",
        "mimetype": "image/jpeg",
        "filename": "profile.jpg"
    }
}
Example response 
{
    "success": true,
    "message": "Profile action completed.",
    "data": {
        "action": "update-picture",
        "session": "{session}",
        "profile_response": {}
    }
}

5. Delete profile picture

Remove the current profile picture from the connected account.

API name

Delete profile picture

Purpose

Remove the current profile picture from the connected account. Use this when your application needs to manage the connected account profile from your own product.

Endpoint

DELETE https://chatflow.zeltacode.com/api/v1/profile/{session}/picture

Replace {session} with a session ID or session name.

curl 
curl -X DELETE "https://chatflow.zeltacode.com/api/v1/profile/{session}/picture" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
Example response 
{
    "success": true,
    "message": "Profile action completed.",
    "data": {
        "action": "delete-picture",
        "session": "{session}",
        "profile_response": {}
    }
}