API reference
Preview the shortlist email
The email send_shortlist_email would send for the project’s shortlist, without sending it: the client workspace, who it goes to, the subject, the text and the people it shows. Sends nothing and makes no link. In testing, as in the app: for keys made by a developer account only (shortlist_email_in_testing otherwise), and every email goes to Revcenter’s test inbox (send_to) instead of the client workspace’s members (intended_recipients). client_workspace_id defaults to the client portal the project is assigned to. url is the client’s link when it already exists; otherwise it is null and sending makes it. Does not use credits.
Needs scope shortlists:read.
POST
/
projects
/
{projectId}
/
shortlist
/
email
/
preview
Preview the shortlist email
curl --request POST \
--url https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_workspace_id": "org_2xClIeNt"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({client_workspace_id: 'org_2xClIeNt'})
};
fetch('https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/preview"
payload = { "client_workspace_id": "org_2xClIeNt" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"client_workspace": {
"id": "org_2xClIeNt",
"name": "Garden State Foods"
},
"mode": "test",
"send_to": [
"test-inbox@revcenter.ai"
],
"intended_recipients": [
"hiring@gardenstatefoods.example"
],
"subject": "14 candidates for Plant Controller, Camden NJ",
"text": "Open the shortlist: https://app.revcenter.ai/share/rvs_3f9a1c7e2b\n…",
"url": "https://app.revcenter.ai/share/rvs_3f9a1c7e2b",
"link_exists": true,
"total": 14,
"people": [
{
"name": "Dana Whitfield",
"title": "Plant Controller",
"company": "Garden State Foods",
"location": "Cherry Hill, NJ",
"linkedin_url": "https://www.linkedin.com/in/example",
"score": 91
}
]
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}Authorizations
An API key from Settings → Usage → API (rvc_live_…).
Path Parameters
A project id
Body
application/json
The client workspace to email; defaults to the client portal the project is assigned to.
⌘I
Preview the shortlist email
curl --request POST \
--url https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_workspace_id": "org_2xClIeNt"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({client_workspace_id: 'org_2xClIeNt'})
};
fetch('https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/preview"
payload = { "client_workspace_id": "org_2xClIeNt" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"client_workspace": {
"id": "org_2xClIeNt",
"name": "Garden State Foods"
},
"mode": "test",
"send_to": [
"test-inbox@revcenter.ai"
],
"intended_recipients": [
"hiring@gardenstatefoods.example"
],
"subject": "14 candidates for Plant Controller, Camden NJ",
"text": "Open the shortlist: https://app.revcenter.ai/share/rvs_3f9a1c7e2b\n…",
"url": "https://app.revcenter.ai/share/rvs_3f9a1c7e2b",
"link_exists": true,
"total": 14,
"people": [
{
"name": "Dana Whitfield",
"title": "Plant Controller",
"company": "Garden State Foods",
"location": "Cherry Hill, NJ",
"linkedin_url": "https://www.linkedin.com/in/example",
"score": 91
}
]
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}{
"error": {
"code": "search_not_found",
"message": "No search with that id in this workspace.",
"details": null,
"request_id": "req_01JABCDEF"
},
"meta": {
"request_id": "req_01JABCDEF"
}
}