---
updatedAt: 2026-07-24T20:23:28.000Z
agentTools:
  projectIndex: https://readme.paradox.ai/llms.txt
---

# Send interview alerts

This API allows 3rd party integrators to send Interview Requests to Paradox.  Additionally, this API will create Candidates within Paradox that do not exist.

<Accordion title="Enable our new validation for Interview Alerts scheduling" icon="fa-info-circle">
  Before integrating with this API surface, enable the following setting so requests are validated consistently
  <ul>
    <li>
      <strong>Navigation</strong>
      <ul>
        <li>Settings → Client Setup → Integrations</li>
      </ul>
    </li>
    <li>
      <strong>Toggle</strong>
      <ul>
        <li>Enable Validation for Interview Alerts Scheduling</li>
      </ul>
    </li>
    <li>
      <strong>Effect</strong>
      <ul>
        <li>New Public API scheduling requests for interviews are validated (optional attendees, attendee counts, required roles, and related rules).</li>
      </ul>
    </li>
  </ul>
</Accordion>

#### Results

Calling '/interview/interview\_alerts' endpoint.\
This is the parameters to alert for an interview

|                          Key | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ---------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|                          OID | Candidate id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                       action | The action of interview (interview, cancel, reschedule)                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                      by\_web | 1 if interview by web                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|               schedule\_time | the Schedule time                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|        interview\_jobloc\_id | the Interview jobloc id                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|          interview\_duration | the Interview duration                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|              interview\_type | the Interview type include IN\_PERSON\_INTERVIEW = 1 PHONE\_INTERVIEW = 2 IN\_PERSON\_MEETING = 3 PHONE\_MEETING = 4 SEQUENTIAL\_INTERVIEW = 5 SEQUENTIAL\_MEETING = 6 VIRTUAL\_INTERVIEW = 7 VIRTUAL\_MEETING = 8 GROUP\_INTERVIEW = 9 PHONE\_CONVERSATION = 10 IN\_PERSON\_CONVERSATION = 11 VIRTUAL\_CONVERSATION = 12 IN\_PERSON\_SESSION = 13 PHONE\_SESSION = 14 SEQUENTIAL\_SESSION = 15 VIRTUAL\_SESSION = 16 GROUP\_SESSION = 17 INTERVIEW\_PREFERENCE = 18 BREAK = 19 (max length: 6) |
|      interview\_instructions | the Interview Instructions                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|  interview\_jobloc\_room\_id | the ID of the interview room                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|             interviewer\_ids | id list of the interviewers                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                           ip | ip of the candidate                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                     lead\_id | id of the candidate                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| using\_calendar\_popup\_page | For all interview web pages using calendar pop up                                                                                                                                                                                                                                                                                                                                                                                                                                               |

The result will:\
**In case success is 1, the keys as below:**

|             Key | Description                              |
| --------------: | :--------------------------------------- |
|         success | 1                                        |
| interview\_data | the error                                |
| recruiter\_text | Recruiter message that send to candidate |
|       processed | 1: have sent an alert, 0: not yet        |
|     company\_id | The company id of a candidate            |
|       candidate | Candidate-specific data(OID)             |

**In case success is 0, the keys as below:**

|   Key | Description       |
| ----: | :---------------- |
| error | the error message |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "olivia-public-api-docs",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.paradox.ai/api/v1/public"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/interview/interview_alerts": {
      "put": {
        "summary": "Send interview alerts",
        "description": "This API allows 3rd party integrators to send Interview Requests to Paradox.  Additionally, this API will create Candidates within Paradox that do not exist.",
        "operationId": "send-interview-alerts",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string",
              "default": "Bearer <oauth_token>"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "action",
                  "interview_duration",
                  "interview_type"
                ],
                "properties": {
                  "OID": {
                    "type": "integer",
                    "description": "Paradox candidate application ID. (max length :20 )",
                    "format": "int32"
                  },
                  "ex_id": {
                    "type": "string",
                    "description": "An external candidate ID (max length :255 )"
                  },
                  "job_application_id": {
                    "type": "string",
                    "description": "A candidate's external job application ID. (max length: 255 )"
                  },
                  "use_application_id_for_identity": {
                    "type": "boolean",
                    "description": "Use the candidate’s Job Application ID as their unique identifier. Using this parameter will allow for candidates to be created and scheduled from this endpoint."
                  },
                  "action": {
                    "type": "string",
                    "description": "The action of interview: \"interview\" (send interview times to candidate), \"reschedule\" (reschedule the interview), \"cancel\" (cancel the interview)  (max length: 10)",
                    "default": "interview"
                  },
                  "interview_duration": {
                    "type": "integer",
                    "description": "Interview duration in minutes. The maximum amount of time is  415 minutes and the minimum is 5.",
                    "format": "int32"
                  },
                  "interview_type": {
                    "type": "integer",
                    "description": "IN_PERSON_INTERVIEW = 1 PHONE_INTERVIEW = 2 IN_PERSON_MEETING = 3 PHONE_MEETING = 4 SEQUENTIAL_INTERVIEW = 5 SEQUENTIAL_MEETING = 6 VIRTUAL_INTERVIEW = 7 VIRTUAL_MEETING = 8 GROUP_INTERVIEW = 9 PHONE_CONVERSATION = 10 IN_PERSON_CONVERSATION = 11 VIRTUAL_CONVERSATION = 12 IN_PERSON_SESSION = 13 PHONE_SESSION = 14 SEQUENTIAL_SESSION = 15 VIRTUAL_SESSION = 16 GROUP_SESSION = 17 INTERVIEW_PREFERENCE = 18 BREAK = 19 (max length: 6)",
                    "default": 0,
                    "format": "int32"
                  },
                  "custom_interview_type": {
                    "type": "string",
                    "description": "The API ID of the custom interview type"
                  },
                  "interview_segments": {
                    "type": "array",
                    "description": "Interview parameters for each segment of a sequential interview. This parameter can only be used when a sequential interview_type has been selected.",
                    "items": {
                      "properties": {
                        "interview_name": {
                          "type": "string",
                          "description": "Name of the interview segment that will be communicated with the candidate"
                        },
                        "interview_duration": {
                          "type": "integer",
                          "description": "Interview duration in minutes. The maximum amount of time is  415 minutes and the minimum is 5.",
                          "default": "",
                          "format": "int32"
                        },
                        "interview_type": {
                          "type": "string",
                          "description": "IN_PERSON_INTERVIEW = 1, PHONE_INTERVIEW = 2, IN_PERSON_MEETING = 3, PHONE_MEETING = 4, SEQUENTIAL_INTERVIEW = 5, SEQUENTIAL_MEETING = 6, VIRTUAL_INTERVIEW = 7, VIRTUAL_MEETING = 8 (max length: 6)",
                          "default": "2"
                        },
                        "interviewer_emails": {
                          "type": "string",
                          "description": "List of email address of the interviewer(s). (max length: 255 )"
                        },
                        "interviewer_ex_ids": {
                          "type": "string",
                          "description": "List of external employee IDs of the interviewer(s). Ex : [\"e5464656\",\"2523525\"] (max length of employee id: 255)"
                        },
                        "interview_team": {
                          "type": "string",
                          "description": "A dynamic round-robin group based on receiving a list of either user emails or employee IDs. Ex [\"u_1234\", 2523525, abc@example.com]."
                        },
                        "interviewer_ids": {
                          "type": "string",
                          "description": "List of the interview attendees. Ex:[\"u_636\",\"u_74\",\"g_6\",\"exg_1089\"] = User ID 636 and 74 and Round Robin Group ID = 6 and External Group ID = 1089 . (max length of user id: 10)."
                        },
                        "interview_location_address": {
                          "type": "string",
                          "description": "The location on the in-person interview API request that does not match a location in location management."
                        },
                        "interview_jobloc_code": {
                          "type": "string",
                          "description": "The external location ID of the interview job location."
                        },
                        "interview_jobloc_id": {
                          "type": "integer",
                          "description": "The Paradox ID of the interview job location.",
                          "format": "int32"
                        },
                        "interview_jobloc_room_email": {
                          "type": "string",
                          "description": "The room email in job loc room"
                        }
                      },
                      "type": "object",
                      "required": [
                        "interview_duration"
                      ]
                    }
                  },
                  "interviewer_emails": {
                    "type": "array",
                    "description": "List of email address of the interviewer(s). (max length: 255 ) Endpoint will accept either a comma separated list or array of objects.",
                    "items": {
                      "properties": {
                        "email": {
                          "type": "string"
                        },
                        "is_optional": {
                          "type": "boolean",
                          "default": "false"
                        }
                      },
                      "type": "object"
                    }
                  },
                  "interviewer_ex_ids": {
                    "type": "array",
                    "description": "List of external employee IDs of the interviewer(s). Ex : [\"e5464656\",\"2523525\"] (max length of employee id: 255) Endpoint will accept either a comma separated list or array of objects. When using the objects to specify which interviewers are optional the \"Enable Validation for Interview Alerts Scheduling\" toggle must be turned on",
                    "items": {
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "ID of the attendee"
                        },
                        "is_optional": {
                          "type": "boolean",
                          "default": "false"
                        }
                      },
                      "type": "object"
                    }
                  },
                  "interview_team": {
                    "type": "string",
                    "description": "A dynamic round-robin group based on receiving a list of either user emails or employee IDs. Ex '[\"u_1234\", \"2523525\", \"abc@example.com\"]'. It can have up to a maximum of 25 interviewers. User's priority is High"
                  },
                  "alternate_interview_team": {
                    "type": "string",
                    "description": "A dynamic round-robin group based on receiving a list of either user emails or employee IDs. Ex '[\"u_1234\", \"2523525\", \"abc@example.com\"]'. It can have up to a maximum of 25 interviewers. User's priority is Medium"
                  },
                  "interviewer_ids": {
                    "type": "array",
                    "description": "List of Paradox IDs to identify the interview attendees. Ex:[\"u_636\",\"u_74\",\"g_6\",\"exg_1089\"] = User ID 636 and 74 and Round Robin Group ID = 6 and External Group ID = 1089 . (max length of user id: 10). Endpoint will accept either a comma separated list or array of objects.",
                    "items": {
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "ID of the attendee"
                        },
                        "is_optional": {
                          "type": "boolean",
                          "default": true
                        }
                      },
                      "type": "object"
                    }
                  },
                  "interview_jobloc_code": {
                    "type": "string",
                    "description": "The external location ID of the interview job location."
                  },
                  "interview_jobloc_room_id": {
                    "type": "integer",
                    "description": "The Paradox id of the interview room. If -1 is sent as the value, the Paradox logic of “Any Available Room” will be utilized.",
                    "format": "int32"
                  },
                  "interview_jobloc_id": {
                    "type": "integer",
                    "description": "The Paradox ID of the interview job location.",
                    "format": "int32"
                  },
                  "interview_location_address": {
                    "type": "string",
                    "description": "A valid street address to be used for the interview location. This does not have to be an existing location in the Paradox environment."
                  },
                  "interview_instructions": {
                    "type": "string",
                    "description": "This is Interview Instructions (max length : 320)"
                  },
                  "candidate_interview_prep_ex_id": {
                    "type": "string",
                    "description": "The Interview Prep External ID of the candidate (max length: 255 )"
                  },
                  "recruiter_interview_prep_ex_id": {
                    "type": "string",
                    "description": "The Interview Prep External ID of the recruiter (max length: 255 )"
                  },
                  "interview_owner_email": {
                    "type": "string",
                    "description": "The interview owner’s email address (max length: 255 ). If no interview owner is provided, the user tied to the API credentials will be used."
                  },
                  "interview_owner_ex_id": {
                    "type": "string",
                    "description": "The interview owner’s external id. If no interview owner is provided, the user tied to the API credentials will be used."
                  },
                  "generate_virtual_url": {
                    "type": "boolean",
                    "description": "Generate a virtual interview URL for this interview",
                    "default": false
                  },
                  "private": {
                    "type": "integer",
                    "description": "The privacy setting of an interview: 0 = Public, 1 = Private. If this field is not included the account default will be used.",
                    "default": 0,
                    "format": "int32"
                  },
                  "first_name": {
                    "type": "string",
                    "description": "Candidate first name. (max length of name : 50 )"
                  },
                  "last_name": {
                    "type": "string",
                    "description": "Candidate last name. (max length of name : 50 )"
                  },
                  "phone": {
                    "type": "integer",
                    "description": "Candidate phone number. (max length: 20 )",
                    "format": "int32"
                  },
                  "email": {
                    "type": "string",
                    "description": "Candidate email address. (max length: 50 )"
                  },
                  "job_title": {
                    "type": "string",
                    "description": "Job name. (max length: 255 )"
                  },
                  "job_req_id": {
                    "type": "integer",
                    "description": "An external Job Requisition ID (max length: 50 )",
                    "format": "int32"
                  },
                  "job_loc_code": {
                    "type": "string",
                    "description": "Location code of job. (max length : 20)"
                  },
                  "candidate_journey": {
                    "type": "string",
                    "description": "Candidate journey name"
                  },
                  "candidate_journey_status": {
                    "type": "string",
                    "description": "Candidate journey status ( {Candidate_journey_stage_name}: {Candidate_journey_status_name}"
                  },
                  "sequential_order_automation": {
                    "type": "integer",
                    "description": "Scheduling order logic ( default : -1 ) (In Order Only) = 0, (In Order, Any Order) = 1, (In Order, Any Order, Multi-Day) = 2, (Multi-Day Only) = 3",
                    "format": "int32"
                  },
                  "recorded_interview_id": {
                    "type": "string",
                    "description": "The external id of recorded interview"
                  },
                  "interview_jobloc_room_ex_id": {
                    "type": "string",
                    "description": "The external id in job loc room"
                  },
                  "interview_jobloc_room_email": {
                    "type": "string",
                    "description": "The room email in job loc room"
                  },
                  "resume": {
                    "type": "string",
                    "description": "Binary/Base64 String Resume file (.pdf, .doc', .docx, .png, .jpg', .txt') (Must be <10mb)"
                  },
                  "force_sequent_multi_days": {
                    "type": "boolean",
                    "description": "To make the sequent interview multiple days.",
                    "default": false
                  },
                  "notes_data": {
                    "type": "string",
                    "description": "only apply for is_kenexa_request (is_kenexa_request determine by data has keys [\"Sender\", \"TransactInfo\", \"Packet\"])"
                  },
                  "note": {
                    "type": "string",
                    "description": "create candidate note"
                  },
                  "attendee_count": {
                    "type": "string",
                    "description": "Set Number of Attendees for all Round Robin Groups and Interview Team of an Interview"
                  },
                  "use_paradox_status_map": {
                    "type": "string",
                    "description": "To identify the use of status_map_name and status_map_ex_id",
                    "default": "false"
                  },
                  "status_map_name": {
                    "type": "string",
                    "description": "Name of the Journey Status Mapping in Paradox. Required when use_paradox_status_map is true"
                  },
                  "status_map_ex_id": {
                    "type": "string",
                    "description": "Name of the status in the external system. The ID that is associated with a specific Journey Status in Paradox"
                  },
                  "primary_contact_method": {
                    "type": "string",
                    "description": "1 = Email, 2 = SMS, 3 = Email & SMS, 4 = WhatsApp & Email, 5 = Whatsapp. Default = Email & SMS"
                  },
                  "debrief": {
                    "type": "object",
                    "properties": {
                      "debrief_duration": {
                        "type": "string",
                        "description": "Length of the debrief. Time in minutes. min 5 - max 415"
                      },
                      "debrief_type": {
                        "type": "integer",
                        "description": "IN_PERSON_INTERVIEW = 1 \nPHONE_INTERVIEW = 2  \nVIRTUAL_INTERVIEW = 7 "
                      },
                      "debrief_location_address": {
                        "type": "string",
                        "description": "This or debrief_jobloc_code is required for In_PERSON_INTERVIEW"
                      },
                      "debrief_jobloc_code": {
                        "type": "string",
                        "description": "This or debrief_location_address is required for In_PERSON_INTERVIEW"
                      },
                      "debrief_jobloc_room_ex_id": {
                        "type": "integer"
                      },
                      "debrief_jobloc_room_email": {
                        "type": "string"
                      },
                      "is_optional": {
                        "type": "boolean",
                        "description": "true/false",
                        "default": "false"
                      }
                    },
                    "description": "All child properties are required for a debrief."
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "first_name": "John",
                    "last_name": "Doe",
                    "phone": "+15555555555",
                    "email": "johndoe@mailinator.com",
                    "ex_id": "1234",
                    "job_req_id": "R1234",
                    "job_application_id": "applicationID",
                    "job_title": "API Developer",
                    "use_application_id_for_identity": true,
                    "action": "interview",
                    "interview_duration": 15,
                    "interview_type": 1,
                    "interview_jobloc_code": "Location1",
                    "interviewer_emails": "interviewer1@company.com"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"error\": \"\",\n    \"interview_data\": {\n        \"processed\": 1,\n        \"text\": \"In-Person Interview request has been sent to Candidate Name\"\n    },\n    \"success\": 1\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": ""
                    },
                    "interview_data": {
                      "type": "object",
                      "properties": {
                        "processed": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "text": {
                          "type": "string",
                          "example": "In-Person Interview request has been sent to Candidate Name"
                        }
                      }
                    },
                    "success": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```