Commit
This endpoint should only be accessed if the keepAlive parameter was set to true when retrieving the data. Invoking this endpoint marks the data retrieval as “Complete” and expires the access token.
Header Parameters
Authorizationstring Required
Authorization token
Content-Typestring
Query Parameters
keepFilesboolean Required
This parameter determines how exported data is managed. If set to true, the system retains the export files used by the API to retrieve data while marking the token as retrieved. By default, this is set to false, ensuring the system automatically deletes these files after retrieval.
Path Parameters
clientIdstring Required
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
accessTokeninteger Required
Secure token returned by the Initiate call, required as a URL parameter in all subsequent API requests.
Response
200
Object
OK - The request was successfully received.
400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found. See error description for more details.
503
Object
The server is unable to handle your request due to a temporary condition. You must delay your request for some time before trying again. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?