Add or replace phone numbers
PUT/v1/businesses/{businessId}/phone-numbers
Replaces the state of several numbers at once. For each item,
branding and spoofDefense are both required — PUT sets the
number to exactly what you send, so pass null for a product you do not
want. A number that isn't registered yet is created.
Use PATCH instead to change one product and leave the other untouched.
Numbers you leave out of the list are not touched — they are
neither changed nor removed. PUT here replaces the state of each
number you send, not the business's whole set of numbers; use
POST …/phone-numbers/delete to remove numbers.
The business must have completed verification (ACTIVE or
INACTIVE).
Path Parameters
The ID of the business, assigned by Hiya.
9b8a1c4e-2c0f-4f3d-9a1e-7b3a2b4c6d8fHeader Parameters
Your own correlation ID for this call, returned as
requestId
400
INVALID_HEADER
Possible values: <= 200 characters, Value must match regular expression ^[A-Za-z0-9._:/+=@-]+$
job-2f9c1a7e-0042Body
required
Responses
- 200
- 400
- 401
- 404
- 409
- 500
The batch was processed. Check the response to see which numbers were replaced and which need attention.
Response Body
The request is invalid — for example phoneNumbers is missing or
has more than 1000 items, a supplied branding has no
displayName, or the X-Hiya-Request-Id header doesn't match its
pattern. A number Hiya can't apply doesn't cause this — it is
reported in needsAttention.
Response Body
The API key is missing or invalid.
Response Body
The business doesn't exist, or isn't one of yours — the two are indistinguishable by design.
Response Body
The business hasn't completed verification yet, or is being deleted,
so numbers can't be registered or replaced. A verified business
whose branded call is switched off (INACTIVE) still accepts them.
Response Body
Something went wrong on our side.
Response Body