v1

latestSwagger 2.02026-08-06114161439.7 KB
SMS Broadcast

Update contact details

Update the phone number and name of an existing contact

put/contacts/{contact_id}

Path parameters

contact_idinteger required

The ID of the contact to update

Request body

contact_namestring

Updated name of the contact. Type: string.

phone_numberstring

Phone number as a string of digits. Typically 10 digits for US numbers.

country_codestring

Updated country code for the phone number (must be +1). Type: string.

status'active' | 'inactive' | 'deleted'

Updated status of the contact. Type: enum (string); Allowed values: active, inactive, deleted.

Example request

{
  "contact_name": "John Doe",
  "phone_number": "1234567890",
  "country_code": "+1"
}

Response

Contact updated successfully

statusstring

Status of the operation. Type: string.

messagestring

SMS message body. String. Max length set by carrier (typically 160 chars for single-segment, up to 1600 for concatenated).

errorstring

Error message if operation failed. Type: string.

Example response

{
  "status": "success",
  "message": "Contact updated successfully",
  "error": "Invalid contact ID"
}