Skip to main content
PATCH
Update
Bot users are now called service users, and ngrok plans to remove this API. Use the Service Users API instead. This API also doesn’t support service user roles.

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 service user

active
boolean

whether or not the service user is active

Response

Update attributes of a bot user by ID.

id
string

unique API key resource identifier

uri
string

URI to the API resource of this service user

name
string

human-readable name used to identify the service user

active
boolean

whether or not the service user is active

created_at
string

timestamp when the api key was created, RFC 3339 format