Cancel a plan

End the plan for every location in an account. The plans close immediately, so review collection and posting stop straight away, and your account team is notified. Cancel before you remove the account's locations: once it has no active or pending locations the call returns 404. To cancel only some locations, use Cancel a plan (selected locations).

Prerequisites: the account's id (company_id) and a cancelling_reason.

Authentication: Partner or Account token. company_id must be an existing account inside your own account tree (otherwise 422), and the caller must be the account itself or its direct parent (otherwise 403).

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 5994

The account whose plan to cancel.

string
enum
required
Defaults to Price too high

One of: Price too high, Response quality not good enough, Another solution in place, Prefer to respond myself, Do not get enough reviews to justify it, Responses are not important to our business, Other.

Allowed:
string
Defaults to Switching to a competitor

More detail, e.g. with Other. Max 255 characters.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json