Cancel invitation
post/v1/users/cancelInvitationThis API allows you to cancel the invitation that you have already sent from BoldSign to the specific user.
Cancel invitation mail can be sent only to the users who did not accept their invitation, which was already sent from BoldSign.
Code snippet
curl -X 'POST' \ 'https://api.boldsign.com/v1/users/cancelInvitation?userId=e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx' \ -H 'accept: */*' \ -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}"); var userClient = new UserClient(apiClient); userClient.CancelInvitation("e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx");
import boldsign configuration = boldsign.Configuration(api_key="YOUR_API_KEY") with boldsign.ApiClient(configuration) as api_client: user_api = boldsign.UserApi(api_client) user_api.cancel_invitation(user_id="YOUR_USER_ID")
<?php require_once "vendor/autoload.php"; $config = new BoldSign\Configuration(); $config->setApiKey('YOUR_API_KEY'); $user_api = new BoldSign\Api\UserApi($config); $user_api->cancelInvitation($user_id='YOUR_USER_ID');
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); UserApi userApi = new UserApi(client); userApi.cancelInvitation("YOUR_USER_ID");
import { UserApi } from "@boldsign/node-sdk"; const userApi = new UserApi(); userApi.setApiKey("YOUR_API_KEY"); userApi.cancelInvitation("YOUR_USER_ID");
Request body
userIdstringRequired | The ID of the user account. |
Example response
200 Success