Skip to main content

Delete a business

DELETE 
/v1/businesses/{businessId}

Shuts the business down: permanently deletes it and all of its data across Hiya, including its phone numbers. This can't be undone.

This runs as a background process. The request is accepted (202) and the deletion completes asynchronously; a business.deleted webhook is sent once it has.

The call is idempotent: repeating it while the teardown is running is accepted (202) and lets the running teardown continue. Meanwhile branded-call and spoof-defense changes, and every write in the Phone API, return 409. Once it has finished the business is gone and returns 404.

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

Responses​

Accepted. The business is being shut down, or its shutdown was already under way.

Response Body

application/json