Skip to main content

Partially update phone numbers

PATCH 
/v1/businesses/{businessId}/phone-numbers

Changes some of what several numbers carry, leaving the rest alone. For each item, omit branding or spoofDefense to leave it unchanged, send null to clear it, or send an object to replace it. The two are independent — changing one never affects the other.

A supplied object replaces that object entirely, so include its required fields. This is not RFC 7396 merge patch: nesting is not merged.

Unlike PUT, this never creates a number — a number that isn't registered is reported in needsAttention with NOT_FOUND, and the rest of the batch is still applied. Sending every field makes this equivalent to PUT.

The business must have completed verification (ACTIVE or INACTIVE).

Path Parameters​

    businessId string<uuid>required

    The ID of the business, assigned by Hiya.

    Example: 9b8a1c4e-2c0f-4f3d-9a1e-7b3a2b4c6d8f

Header Parameters​

    X-Hiya-Request-Id string

    Your own correlation ID for this call, returned as 

    requestId
    in the response body. Hiya generates one if omitted. A value that doesn't match the pattern is rejected with 
    400
    INVALID_HEADER
    .

    Possible values: <= 200 characters, Value must match regular expression ^[A-Za-z0-9._:/+=@-]+$

    Example: job-2f9c1a7e-0042

Body

required

application/json

Responses​

The batch was processed. Check the response to see which numbers were updated and which need attention.

Response Body

application/json