Cancel a plan (selected locations)

post

https://production-api.shoutaboutus.com/api/v1/account/cancel-store-subscriptions

End the plan for selected locations under an account, leaving the rest running. The plans close immediately for those locations, and review collection and posting stop for them. Your account team is notified.

Prerequisites: the locations' ids (store_ids).

Authentication: Partner or Account token. The caller must be the one who pays (a partner that pays for its locations, or an account that pays for its own); otherwise 403. Every location must be inside your own account tree; otherwise 422.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

store_ids

array of integers

required

Defaults to 3008

The locations whose plans to cancel.

store_ids*

cancelling_reason

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:

cancelling_reason_other

string | null

Defaults to Location closed

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

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The plans are cancelled for those locations.

401The token is missing, expired or invalid.

403You aren't the one who pays for these locations (Permission denied).

422The request failed validation: store_ids missing or outside your tree, or an invalid reason.

500None of the locations is active or pending in your scope, or an unexpected server error.