Cancel invitation

post/v1/users/cancelInvitation

This 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 requests

url = "https://api.boldsign.com/v1/users/cancelInvitation?userId=e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx"

payload={}
headers = {
  'accept': '*/*',
  'X-API-KEY': '{your API key}'
}

response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
const axios = require('axios');
const response = await axios.post(
    'https://api.boldsign.com/v1/users/cancelInvitation',
    
    {
        params: {
            'userId': 'e892ea92-xxxx-xxxx-xxxx-bbdbcaa5xxxx'
        },
        headers: {
            'accept': '*/*',
            'X-API-KEY': '{your API key}',
            'Content-Type': 'application/x-www-form-urlencoded'
        }
    }
);

Request body

NameType
userIdstringRequiredThe ID of the user account

Example response

200 Success