HomeAPI ReferenceSupport
API Reference

Opt Out

post
https://developer-api.partner.mygridshare.com/api/v1/flexDispatches//optOut

Opt a participant out of a flex dispatch. The participant can be identified by either site ID or participant ID. If the participant has already been opted out of this dispatch, the original opt-out details are returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the flex dispatch.

Body Params
string
enum
required

Specifies the type of identifier, in this case, a site.

Allowed:
string
required

The site to opt out of the dispatch.

Responses

Updated about 1 month ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 month ago