Skip to main content
PUT
/
api
/
v2
/
SenderId
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": "<string>"
}

Update Sender ID

Update the purpose or description of an existing sender ID.
curl -X PUT "https://accounts.netvox.ng/api/v2/SenderId?id=94" \
  -H "Content-Type: application/json" \
  -d '{
    "SenderId": "YOURBRAND",
    "Purpose": "Updated purpose description",
    "ApiKey": "YOUR_API_KEY",
    "ClientId": "YOUR_CLIENT_ID"
  }'

Parameters

id
number
required
ID of the sender ID to update

Request Body

SenderId
string
required
The sender ID text (cannot be changed, must match existing)
Purpose
string
required
Updated purpose or description
ApiKey
string
required
Your API key for authentication
ClientId
string
required
Your client identifier for authentication

Response

ErrorCode
number
Error code (0 for success)
ErrorDescription
string
Description of the result
Data
string
Success message

Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": "SenderId updated Successfully."
}

Use Cases

  • Purpose updates: Change the description of your sender ID
  • Documentation: Keep sender ID purposes up to date
  • Compliance: Update sender ID information for regulatory requirements