Bot Users
Create Bot User
Create a new bot user
Request
POST /bot_users
Example Request
curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"name":"new bot user from API"}' \
https://api.ngrok.com/bot_users
Parameters
Name | Type | Description |
---|---|---|
name | string | human-readable name used to identify the bot |
active | boolean | whether or not the bot is active |
Response
Returns a 201 response on success
Example Response
{
"active": true,
"created_at": "2024-06-14T06:04:05Z",
"id": "bot_2hrGzYWDqXgoCjks31VRmz6EzKH",
"name": "new bot user from API",
"uri": "https://api.ngrok.com/bot_users/bot_2hrGzYWDqXgoCjks31VRmz6EzKH"
}
Fields
Name | Type | Description |
---|---|---|
id | string | unique API key resource identifier |
uri | string | URI to the API resource of this bot user |
name | string | human-readable name used to identify the bot |
active | boolean | whether or not the bot is active |
created_at | string | timestamp when the api key was created, RFC 3339 format |
Delete Bot User
Delete a bot user by ID
Request
DELETE /bot_users/{id}
Example Request
curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/bot_users/bot_2hrGzYWDqXgoCjks31VRmz6EzKH
Response
Returns a 204 response with no body on success