Set status via API

Set status via API



Set status via API.



Introduction

Welcome, this is a tutorial to help set status via API.



Defines a user status when status message and status are provided.


Arguments:

URL
Require Authentication
Method HTTP
/api/v1/users.setAvatar
yes
POST


 Payloads

Arguments
Example
Required
Description
message

My status update

required

The User Status Message.

status

online

Optional

The user's status, such as (online, busy, away, away).



Call Example



  1. curl -H "X-Auth-Token: 40tB-Cn5YQJ74QMlQXi4Zf4E_-e0P5CrklU2pWOtV9M" \
     -H "X-User-Id: uunbZHiuEnib8Pawj" \
     -d '{"message": "Minha atualização de status", "status": "online"}' \

Result:
  1. {

    "success" : true
    }



In case of doubts or suggestions, please contact our support via e-mail: suportebr@myhive.global




    • Related Articles

    • Set Avatar Image via API

      Set Avatar Image via API. Introduction Welcome, this is a tutorial to set avatar image via API. Uploading a file. Arguments: URL Require Authentication Method HTTP /api/v1/users.setAvatar yes POST Payloads Arguments Example Required Description image ...
    • Paging via API

      Paging via API. Introduction Welcome, this is a tutorial to help understand how to count, offset, sort via API. As of version, some of the endpoints support query parameters, and . However, the defaults are different by server due to configuration ...
    • Disable users via API.

      Disable users via API. Introduction Welcome, this is a tutorial to disable user via API. Note: Disable inactive users. Permission required:    edit-other-user-active-status. Parameters URL Require Authentication Method HTTP ...
    • Creating user via API.

      Creating user via API. Introduction Welcome, this is a tutorial to login via API Parameters URL Require Authentication Method HTTP /api/v1/users.create yes POST Variables Note: To save customFields, you must first define customFields in the admin ...
    • List users and information via API

      List users and information via API Introduction Welcome, this is a tutorial to list users and their information via API. Listing Gets all users in the system and their information, the result is limited only to what the receiver has access to view. ...