About iMochaHelpBook a demo
About iMochaHelpBook a demo
  1. Test Invitations
  • Introduction
  • Skills Assessment API
    • API Reference
      • Getting started
      • API Environment
      • Authentication Mechanism
      • Error Code
      • List timezones
    • Test
      • List all tests
      • Retrieve a test
      • Retrieve test settings
      • Update Test Settings
    • Test Invitations
      • Callback notification
      • Invite candidate
        POST
      • Invite candidate by test link
        POST
      • Bulk Invite
        POST
      • Reattempt Test
        POST
      • Cancel Invitation
        POST
    • Test Link
      • List all test links
      • Create Test Link
      • Update Test Link
    • Report
      • Retrieve candidate test report
      • Retrieve candidate test report in PDF
      • Get Reports By TestId
      • Get All Reports
    • Callback API
      • Process Callbacks
      • Retrieve Invites
    • GDPR
      • GDPR Data Masking Service
    • Users
      • Get all business units
      • Create New User
      • Update User
      • Active/ Inactive User
    • Tara Interview API
      • Introduction
      • Get All Interviews
      • Schedule Interview
      • Get Detailed Report
      • Get All Reports
  • Skills Intelligence API
    • Introduction
    • Authentication
    • Employee
      • List employees
      • Get Employee Skills by employeeId
      • Employee Enrollment
      • Get Employee Certificates
      • Update Employee Status
      • Get Employee Assessment Report
      • Upload Certificate for Employee
      • Upload Resume for Employee
      • List Employees with Skills Profile
      • Assign Learning to Employee
      • Get Employee Skill Gap
    • JobProfiles
      • Get All JobProfiles
      • Get JobProfile with Skills By JobProfileId
      • Create JobCode
    • Taxonomy
      • Get all Taxonomy Skills
    • CareerPath
      • Get Employee Career Path by employeeId
    • Account
      • Get Rubric Levels
      • Get Multichannel Validation Weightages
    • Learning
      • Create Learning Resources
      • Get all Learning Resources
    • Certificates
      • Create certificate with skills
      • Get all Certificates
  1. Test Invitations

Cancel Invitation

POST
/v3/invitations/{testInvitationId}/cancel
🔶 Cancel test invitation send to candidate
API Behavior
Invitation can only be canceled when it is in one of the below states:
  • Pending
Invitation can not be canceled when it is in one of the below states:
  • Inprogress
  • Complete
  • Expired
  • Canceled
  • Test Left
  • Terminated

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https://apiv3.imocha.io/v3/invitations/{testInvitationId}/cancel' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data '{}'
Response Response Example
{
    "testInvitationId": 0,
    "status": "string"
}
Modified at 2025-08-19 13:32:43
Previous
Reattempt Test
Next
List all test links
Built with