Skip to main content

Remove a phone number

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

Unregisters one phone number. Removing a number that isn't registered to the business still returns 200, so the call is safe to repeat; a 404 only ever means the business doesn't exist or isn't yours.

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

Responses​

The number was unregistered.

Response Body

application/json