SAsalesforce
botData

Get botData

Changed on
get/botData/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/botData/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or name of the botData to retrieve

Query parameters

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

Response

Success, returns specified botData

idstring

UUID of the specified bot data

namestring

Name of the bot data

valuestring

Current value of the bot data

roomIdinteger

The room number of the room of the bot data

botIdstring

UUID of the specified bot in that room

createdBystring

Id of the User who created this botData.

Changes