Skip to main content

Add or replace a phone number

PUT 
/v1/businesses/{businessId}/phone-numbers/{phoneNumber}

Sets one phone number to exactly what you send. branding and spoofDefense are both required — pass null for a product you do not want rather than omitting it, since PUT replaces the number's whole state. A number that isn't registered yet is created.

Use PATCH instead to change one product and leave the other untouched.

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
    phoneNumber phone_E164PhoneNumber (string)required

    An E.164 phone number, URL-encoded — the leading 

    +
    becomes 
    %2B
    (e.g. 
    %2B12065550123
    ).

    Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$

    Example: +12065550123

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 phone number after the update.

Response Body

application/json