Set Spoof Defense

PUT 
/v1/businesses/{businessId}/spoof-defense

Turns Spoof Defense on or off for the business, per the enabled flag in the body.

The business must have completed verification; one already disabled can still be toggled. A business still under review, or one being shut down, returns 409.

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

Spoof Defense was updated. Returns the updated business.

Response Body

application/json

400

The request is invalid — enabled is missing or not a boolean, 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

No business with that ID exists, or it isn't one of yours — the two are indistinguishable by design.

Response Body

application/json

409

The business isn't in a state that allows this change — it hasn't completed verification yet, or it is being shut down. Returned as CONFLICT; the message says which case applies.

Response Body

application/json

500

Something went wrong on our side.

Response Body

application/json