Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Customer

Update a customer's metadata.

Updates internal configuration flags for a customer account. Requires ProjectSuperAdmin permission. Regular users cannot access this endpoint. The response returns the full admin customer object including the updated metadata.

put/customers/{id}/metadata

Path parameters

idstring required

The unique identifier of the customer (UUID). Obtained from the id field of GET /customers.

Request body

rtp_debugboolean

When set to true, RTPEngine captures RTP traffic as PCAP files for this customer's calls. Use this to debug audio quality issues (one-way audio, codec problems, jitter). Default is false. Enabling this increases storage usage — disable after debugging.

Example request

{
  "rtp_debug": true
}

Response

The updated customer object with the new metadata applied.

idstring uuid

The unique identifier of the customer.

namestring

Name of the customer.

detailstring

Details about the customer.

emailstring email

Email address of the customer.

phone_numberstring

Customer's contact phone number in E.164 format.

addressstring

Address of the customer.

webhook_method'' | 'POST' | 'GET' | 'PUT' | 'DELETE'

The HTTP method used for webhook (e.g., POST, GET, PUT, DELETE).

webhook_uristring

URI where webhook events are delivered.

billing_account_idstring uuid

The unique identifier of the customer's default billing account. Returned from the GET /billing_accounts/{id} response.

email_verifiedboolean

Whether the customer's email has been verified.

status'active' | 'frozen' | 'deleted'

Account lifecycle status.

identity_verification_status'none' | 'pending' | 'verified' | 'rejected'

Customer's identity verification status. Determines access to PSTN number purchases and outbound PSTN calls.

tm_deletion_scheduledstring date-time

Timestamp when account deletion was requested. Null if not scheduled.

tm_createstring date-time

Timestamp when the customer was created.

tm_updatestring date-time

Timestamp when the customer was last updated.

tm_deletestring date-time

Timestamp when the customer was deleted.

terms_agreed_versionstring

Version identifier of the Terms of Service the customer agreed to. Format: YYYY-MM-DD date string matching a published ToS revision.

terms_agreed_ipstring ipv4

IPv4 address from which the customer accepted the Terms of Service. Logged for legal compliance and audit trail.

Example response

{
  "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "name": "Acme Corporation",
  "detail": "Enterprise customer account",
  "email": "admin@acme.com",
  "phone_number": "+14155551234",
  "address": "123 Main St, San Francisco, CA 94105",
  "webhook_method": "POST",
  "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  "metadata": {
    "rtp_debug": true
  },
  "email_verified": true,
  "status": "active",
  "identity_verification_status": "none",
  "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z",
  "terms_agreed_version": "2026-01-01",
  "terms_agreed_ip": "203.0.113.42"
}