v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB

client

set display name

Sets the display name for the account

post/instances/{id}/client/action/set-display-name

Path parameters

idinteger required

Instance ID

Request body

displayNamestring required

The display name to set for the account

Example request

{
  "displayName": "John Doe"
}

Response

Successfully set display name

status'success' | 'error'

Example response

{
  "data": {
    "status": "success",
    "data": {
      "displayNameSet": true
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/set-display-name"
  },
  "status": "success"
}