Skip to main content
PUT
/
subscribers
/
{id}
curl -X PUT "https://demo.api.vultlocal.com/api/v1/subscribers/sub_abc123" \
  -H "Authorization: Bearer olive_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newemail@example.com"
  }'

{
  "success": true,
  "message": "Subscriber updated successfully",
  "subscriber": {
    "id": "sub_abc123",
    "phone_number": "+23279123456",
    "first_name": "John",
    "last_name": "Doe",
    "email": "newemail@example.com",
    "kyc_level": 2,
    "status": "ACTIVE",
    "updated_at": "2025-01-20T14:45:00Z"
  }
}

​
Request

​
Authorization
string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)

​
Path Parameters

​
id
string
required
Subscriber UUID (e.g., sub_abc123)

​
Body Parameters

All fields are optional. Only include fields you want to update.
​
email
string
Updated email address
​
address
string
Updated physical address
​
kyc_level
integer
New KYC level (1-3). Requires supporting documents.
​
id_number
string
National ID number
​
id_type
string
ID type: NATIONAL_ID, PASSPORT, DRIVERS_LICENSE
​
id_document_url
string
URL to ID document image
​
selfie_url
string
URL to selfie image
​
vult_wallet_id
string
Link VULT wallet ID
​
category
string
Account category: standard, vip, corporate
​
max_child_cards
integer
Maximum child cards allowed
​
relationship_manager_id
integer
Assigned relationship manager ID

​
Response

​
success
boolean
Whether update succeeded
​
message
string
Result message
​
subscriber
object
Updated subscriber object

​
Examples

curl -X PUT "https://demo.api.vultlocal.com/api/v1/subscribers/sub_abc123" \
  -H "Authorization: Bearer olive_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newemail@example.com"
  }'

{
  "success": true,
  "message": "Subscriber updated successfully",
  "subscriber": {
    "id": "sub_abc123",
    "phone_number": "+23279123456",
    "first_name": "John",
    "last_name": "Doe",
    "email": "newemail@example.com",
    "kyc_level": 2,
    "status": "ACTIVE",
    "updated_at": "2025-01-20T14:45:00Z"
  }
}

​
KYC Upgrade Requirements

Level 1 → 2

  • Valid ID document
  • ID number

Level 2 → 3

  • Proof of address
  • Selfie verification

Special Categories

  • VIP review
  • Corporate documents

​
Errors

StatusCodeDescription
400INVALID_REQUESTInvalid field values
401UNAUTHORIZEDInvalid or missing API key
403FORBIDDENCannot update this subscriber
404NOT_FOUNDSubscriber not found
500INTERNAL_ERRORServer error

Authorizations

​
Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Path Parameters

​
id
string
required

Subscriber ID

Body

application/json

Update details

​
address
string
Example:

"456 New St"

​
category
string
Example:

"vip"

​
district
string
Example:

"Western Rural"

​
email
string
Example:

"newemail@example.com"

​
id_back_url
string
Example:

"s3://bucket/kyc/subscriber-id/id-back/file.jpg"

​
id_front_url
string
Example:

"s3://bucket/kyc/subscriber-id/id-front/file.jpg"

​
kyc_level
integer
Example:

2

​
max_child_cards
integer
Example:

100

​
national_id
string
Example:

"ID123456789"

​
relationship_manager_id
integer
Example:

1

​
vult_wallet_id
string
Example:

"VULT123456"

Response

Update successful

The response is of type object.