Rejects an invitation.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
HandshakeId | string | Yes | The ID of the invitation. | h-ycm4rp**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"Handshake": {
"Status": "Declined",
"ExpireTime": "2018-08-10T09:55:41Z",
"ResourceDirectoryId": "rd-abcdef****",
"CreateTime": "2018-08-10T09:55:41Z",
"Note": "Welcome\n",
"TargetEntity": "someone@example.com",
"MasterAccountId": "172841235500****",
"MasterAccountName": "Alice",
"ModifyTime": "2018-08-10T09:55:41Z",
"TargetType": "Email",
"HandshakeId": "h-ycm4rp****"
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | MissingParameter.HandshakeId | You must specify HandshakeId. | - |
400 | InvalidParameter.HandshakeId | The HandshakeId is invalid. | - |
404 | EntityNotExists.Handshake | The specified handshake does not exist. | - |
409 | HandshakeStatusMismatch | The invitation is invalid. | The invitation is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
No change history