Create Custom Status
    • Dark
      Light
    • PDF

    Create Custom Status

    • Dark
      Light
    • PDF

    Article summary

    Post
    /api/v1/custom-user-status.create

    Create a custom user status.

    Changelog

    VersionDescription
    2.4.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authToken of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The userId of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Body parameters
    Example 1
    {
      "name": "caught up",
      "statusType": "busy"
    }
    object
    name
    string Required

    The name of the custom status.

    statusType
    string Required

    The statusType of the custom status. Valid status type includes: Online, Busy, Away, Offline.

    Responses
    200

    OK

    Example 1
    {
      "customUserStatus": {
        "_id": "65462e97a2f73c7460e18f84",
        "name": "caught up",
        "statusType": "busy",
        "_updatedAt": "2023-11-04T11:44:23.366Z"
      },
      "success": true
    }
    Expand All
    object
    customUserStatus
    object
    _id
    string
    name
    string
    statusType
    string
    _updatedAt
    string
    success
    boolean
    400

    Bad Request

    Name Param
    {
      "success": false,
      "error": "The field Name is required [error-the-field-is-required]",
      "errorType": "error-the-field-is-required",
      "details": {
        "method": "insertOrUpdateUserStatus",
        "field": "Name"
      }
    }
    Status name already in use
    {
      "success": false,
      "error": "The custom user status name is already in use [Custom_User_Status_Error_Name_Already_In_Use]",
      "errorType": "Custom_User_Status_Error_Name_Already_In_Use",
      "details": {
        "method": "insertOrUpdateUserStatus"
      }
    }
    Invalid Status Type
    {
      "success": false,
      "error": "Offline is not a valid status type [error-input-is-not-a-valid-field]",
      "errorType": "error-input-is-not-a-valid-field",
      "details": {
        "method": "insertOrUpdateUserStatus",
        "input": "Offline",
        "field": "StatusType"
      }
    }
    Expand All
    object
    success
    boolean
    error
    string
    errorType
    string
    details
    object
    method
    string
    401

    Unauthorized

    Authorization Error
    {
      "status": "error",
      "message": "You must be logged in to do this."
    }
    object
    status
    string
    message
    string

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.