Skip to main content
PATCH
/
bot_users
/
{id}
Update
curl --request PATCH \
  --url https://api.ngrok.com/bot_users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "active": true
}
'
{
  "id": "<string>",
  "uri": "<string>",
  "name": "<string>",
  "active": true,
  "created_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use the Service Users endpoints instead. Bot Users will soon be deprecated.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
ngrok-version
integer
default:2
required

Path Parameters

​
id
string
required

Body

application/json
​
id
string

n/a

​
name
string

human-readable name used to identify the bot

​
active
boolean

whether or not the bot is active

Response

200 - application/json

Update attributes of a bot user by ID.

​
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