curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/recruit/send-invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidateId": "<string>",
"jobId": "<string>",
"message": "<string>",
"jobLink": "<string>"
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/recruit/send-invite"
payload = {
"candidateId": "<string>",
"jobId": "<string>",
"message": "<string>",
"jobLink": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidateId: '<string>',
jobId: '<string>',
message: '<string>',
jobLink: '<string>'
})
};
fetch('https://app.sideshift.app/api/oauth/v1/recruit/send-invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.sideshift.app/api/oauth/v1/recruit/send-invite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidateId' => '<string>',
'jobId' => '<string>',
'message' => '<string>',
'jobLink' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sideshift.app/api/oauth/v1/recruit/send-invite"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"message\": \"<string>\",\n \"jobLink\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.sideshift.app/api/oauth/v1/recruit/send-invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"message\": \"<string>\",\n \"jobLink\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/recruit/send-invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidateId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"message\": \"<string>\",\n \"jobLink\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"invitesRemaining": 123,
"supportChannelId": "<string>",
"hasInterviewLink": true
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Send a recruit invite
send a recruit invite to a candidate. Requires the recruit:write scope.
curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/recruit/send-invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidateId": "<string>",
"jobId": "<string>",
"message": "<string>",
"jobLink": "<string>"
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/recruit/send-invite"
payload = {
"candidateId": "<string>",
"jobId": "<string>",
"message": "<string>",
"jobLink": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidateId: '<string>',
jobId: '<string>',
message: '<string>',
jobLink: '<string>'
})
};
fetch('https://app.sideshift.app/api/oauth/v1/recruit/send-invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.sideshift.app/api/oauth/v1/recruit/send-invite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidateId' => '<string>',
'jobId' => '<string>',
'message' => '<string>',
'jobLink' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sideshift.app/api/oauth/v1/recruit/send-invite"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"message\": \"<string>\",\n \"jobLink\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.sideshift.app/api/oauth/v1/recruit/send-invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"message\": \"<string>\",\n \"jobLink\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/recruit/send-invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidateId\": \"<string>\",\n \"jobId\": \"<string>\",\n \"message\": \"<string>\",\n \"jobLink\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"invitesRemaining": 123,
"supportChannelId": "<string>",
"hasInterviewLink": true
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Body
Send a recruit invite to a candidate (creates a support channel + delivers a job-widget message, optional custom message, and optional interview-link widget). The acting company is the token tenant; a body companyId is ignored if it differs. Extra fields accepted but ignored (legacy-permissive passthrough).
The candidate user id to invite.
The job id for the invitation.
Optional custom message to send with the invite. Supports the {interviewLink} placeholder, which triggers an interview-booking widget instead of inline text.
Optional custom job link URL used in the job widget.
Response
Invite-sent result with remaining invites and the created support channel id.
Show child attributes
Show child attributes