Remove phone numbers

POST 
/v1/businesses/{businessId}/phone-numbers/delete

Unregisters several phone numbers at once. Numbers that aren't registered to the business are ignored.

This is a POST action rather than a DELETE on the collection, because request bodies on DELETE are unreliable across clients and proxies. To remove a single number, DELETE it directly.

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

200

The numbers were removed.

Response Body

application/json

400

The request is invalid — phoneNumbers is missing, empty, or has more than 1000 items — or the X-Hiya-Request-Id header doesn't match its pattern.

Response Body

application/json

401

The API key is missing or invalid.

Response Body

application/json

404

The business doesn't exist, or isn't one of yours — the two are indistinguishable by design.

Response Body

application/json

409

The business is being deleted.

Response Body

application/json

500

Something went wrong on our side.

Response Body

application/json