Unlock Activity
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Unlocks a previously locked activity. For more information, see Lock an Activity API.
Note:
- It is mandatory to pass the “activityId” in the query string. You can find it using the Retrieve Activity APIs.
- In case the activity is already unlocked, you’ll receive the following exception –
{
"Status": "Error",
"ExceptionType": "MXOperationNotAllowedException",
"ExceptionMessage": "Activity is already unlocked"
}
API URL
URL
GET
https://{host}/v2/ProspectActivity.svc/CustomActivity/Unlock?accessKey=AccessKey&secretKey=SecretKey&activityId=ActivityId
URL Parameters
| Parameter | Description |
|---|---|
| ActivityId | The unique identifier of the activity. |
Response
200 OK
Content-Type: application/json
{
"Status":"Success",
"Message":{
"Id":"Id"
}
}
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. |
