API Reference
API Reference

🌲 provision user

post
https://api.sharpsports.io/v1/pine/partner/provision-user

Provision or deprovision users in your Pine AI whitelabel organization

Authorization

🔐 Private API Key

🌲

Product Required: This endpoint requires Pine AI Chat Whitelabel access.

Body Params
string
enum
required
Defaults to provision

Whether to provision (add) the user, deprovision (remove) them, or update their chat limit overrides without re-provisioning

Allowed:
string
required

The email address of the user

string
required

The URL the user will be redirected to after setting their password. Required when action is 'provision'. Ignored for 'deprovision' and 'update_limits'.

integer | null
≥ 0

Per-user override for monthly Pro chat limit. Optional on 'provision' (omit to inherit the partner-level flat limit). On 'update_limits': pass an integer to set, pass null to clear the override (user falls back to the partner-level flat limit), or omit to leave unchanged.

integer | null
≥ 0

Per-user override for monthly Lite chat limit. Optional on 'provision' (omit to inherit the partner-level flat limit). On 'update_limits': pass an integer to set, pass null to clear the override, or omit to leave unchanged.

Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago