Get Status of a Share/Revoke Request
This API lets you retrieve the status of the lead sharing request made (using the Share a Lead API, Revoke Access to a Shared Lead API, Share an Opportunity or Revoke Access to a Shared Opportunity APIs).
Note: Ensure that you have met the prerequisites listed under Entity Sharing before using this API.
API URL
URL
GET
https://{host}/v2/EntityAccess.svc/Status/Get?accessKey=AccessKey&secretKey=SecretKey&id=Id
URL Parameters
| Parameter | Description |
|---|---|
| Id | The Request Id received in the response of the Share a Lead API, Revoke Access to a Shared Lead API, Share an Opportunity API or Revoke Access to a Shared Opportunity API. |
Response
200 OK
Content-Type: application/json
{
"Status": "Success",
"Message": {
"ResponseText": "Request processed successfully."
},
"ShareStatus": 6,
"ErrorMessage": null
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
