Subscribers
Change PIN
Change subscriber’s 4-digit PIN
POST
Request
string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)Path Parameters
string
required
Subscriber UUID (e.g.,
sub_abc123)Body Parameters
string
required
Current 4-digit PIN
string
required
New 4-digit PIN
Response
boolean
Whether change succeeded
string
Result message
Examples
PIN Rules
Format
- Exactly 4 digits
- Numbers only (0-9)
- No spaces or special characters
Security
- Cannot be same as current PIN
- Sequential patterns discouraged
- Simple patterns (1111) warned
Validation
Notifications
A WhatsApp notification is sent to the subscriber when their PIN is changed.
Errors
Related
Verify PIN
Verify a PIN without changing it
Authorizations
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Path Parameters
Subscriber ID
Response
PIN changed successfully
The response is of type object.