client

set device name

Sets the device name and/or browser name displayed for the Web session.

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

Request

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

Path parameters

idinteger required

Instance ID

Request body

deviceNamestring

The device name to display

browserNamestring

The browser name to display

Example request

{
  "deviceName": "My Bot",
  "browserName": "Chrome"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Device name updated successfully.

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

{
  "status": "success",
  "data": {
    "status": "success"
  }
}

Changes

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