Customer

Update a customer.

Changed on

Updates the details of an existing customer and returns the updated information.

put/customers/{id}

Request

  • Base URL
    https://api.voipbin.net/v1.0
  • URL
    https://api.voipbin.net/v1.0/customers/{id}
  • Auth
    none declared

Path parameters

idstring required

Request body

namestring

Omit to leave the current name unchanged.

detailstring

Omit to leave the current detail unchanged.

emailstring

Omit to leave the current email unchanged.

phone_numberstring

Omit to leave the current phone number unchanged.

addressstring

Omit to leave the current address unchanged.

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

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

webhook_uristring

Omit to leave the current webhook_uri unchanged. NOTE: an explicit empty string ("") is a valid value meaning no webhook target (disables webhook delivery), distinct from omitting the field.

Example request

{
  "webhook_method": "POST"
}

Response

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'initial' | 'active' | 'frozen' | 'deleted' | 'expired'

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"
}

Changes

  • 9bdd4e72ca58Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value of the request property

    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value GET of the request property

    • breaking

      removed the enum value POST of the request property

    • breaking

      removed the enum value PUT of the request property

    • breaking

      the request property type changed from string to no type

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

  • 79e779080bccRevision changes
    • warning

      added the new expired enum value to the //// response property for the response status

    • warning

      added the new initial enum value to the //// response property for the response status