client

set display name

Sets the display name for the account

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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/set-display-name
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

displayNamestring required

The display name to set for the account

Example request

{
  "displayName": "John Doe"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Successfully set display name.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: 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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.