Authenticating The Request
A session key must be provided to authenticate the request.
- code guid
- The force link code provided from the initial link request.
Request Parameters
There are no other request parameters for this request.
Failure Response
Unsuccessful responses always return 4xx HTTP status codes.
{
"success":false,
"errorMessage":"Invalid session key.",
"shouldRetry":false
}
- success bool
- If the request was successful or not. For request failures, this will always be false.
- errorMessage string
- An short message explaining why the request was denied.
This should probably not be shown to clients.
- shouldRetry bool
- If true, this means the request is valid but it couldn't be processed at this current time - usually due to rate limits.
If this value returns as true, it's recommended to wait a few seconds then re-attempt the request. When re-attempting requests, make sure you regenerate the timestamp and hash parameters if no secret is being used.
Success Response
Successful responses always return the HTTP 200 status code.
- success bool
- If the request was successful or not. For request successes, this will always be true.