API reference

Email the shortlist to the client

Email the project’s shortlist to a client workspace, as preview_shortlist_email showed it. It reaches the client, so it runs only from a proposal: preview_action, show the person who gets what, then apply_proposal once they agree. Calling this route directly is refused with proposal_required, and nothing is sent. confirm_workspace_name is the client workspace’s name as the person saw it in preview_shortlist_email; a different name is refused with workspace_name_mismatch, so one client never gets another’s list. Send expected_total (preview_shortlist_email’s total) and a shortlist that has moved since is refused with shortlist_changed. In testing, as in the app: developer keys only, and it goes to Revcenter’s test inbox, never the client’s members. Applying the same proposal twice sends once. Does not use credits. It reaches the client, so the MCP server asks the person first, showing who gets what.

Needs scope shortlists:write.

POST

projects

{projectId}

shortlist

send

Email the shortlist to the client

curl --request POST \
  --url https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_workspace_id": "org_2xClIeNt",
  "confirm_workspace_name": "Garden State Foods",
  "expected_total": 14
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_workspace_id: 'org_2xClIeNt',
    confirm_workspace_name: 'Garden State Foods',
    expected_total: 14
  })
};

fetch('https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/send', 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/send"

payload = {
    "client_workspace_id": "org_2xClIeNt",
    "confirm_workspace_name": "Garden State Foods",
    "expected_total": 14
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "project_id": "6f1c2a0e-3b7d-4c1e-9a52-0d4e8b7c1a11",
    "client_workspace": {
      "id": "org_2xClIeNt",
      "name": "Garden State Foods"
    },
    "mode": "test",
    "sent_to": [
      "test-inbox@revcenter.ai"
    ],
    "intended_recipients": [
      "hiring@gardenstatefoods.example"
    ],
    "url": "https://app.revcenter.ai/share/rvs_3f9a1c7e2b",
    "total": 14
  },
  "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

Authorization

string

header

required

An API key from Settings → Usage → API (rvc_live_…).

Path Parameters

projectId

string

required

A project id

Body

application/json

confirm_workspace_name

string

required

The client workspace's name, as preview_shortlist_email showed it.

client_workspace_id

string

The client workspace to email; defaults to the client portal the project is assigned to.

expected_total

integer

preview_shortlist_email's total; refused if the shortlist holds a different number now.

Required range: x >= 0

Response

Created

data

object

Show child attributes

meta

object

Show child attributes

Email the shortlist to the client

curl --request POST \
  --url https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_workspace_id": "org_2xClIeNt",
  "confirm_workspace_name": "Garden State Foods",
  "expected_total": 14
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_workspace_id: 'org_2xClIeNt',
    confirm_workspace_name: 'Garden State Foods',
    expected_total: 14
  })
};

fetch('https://api.revcenter.ai/v1/projects/{projectId}/shortlist/email/send', 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/send"

payload = {
    "client_workspace_id": "org_2xClIeNt",
    "confirm_workspace_name": "Garden State Foods",
    "expected_total": 14
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "project_id": "6f1c2a0e-3b7d-4c1e-9a52-0d4e8b7c1a11",
    "client_workspace": {
      "id": "org_2xClIeNt",
      "name": "Garden State Foods"
    },
    "mode": "test",
    "sent_to": [
      "test-inbox@revcenter.ai"
    ],
    "intended_recipients": [
      "hiring@gardenstatefoods.example"
    ],
    "url": "https://app.revcenter.ai/share/rvs_3f9a1c7e2b",
    "total": 14
  },
  "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"
  }
}

Get started

Concepts

Tools

Guides

Recipes

Use cases

API reference

Email the shortlist to the client

Authorizations

Path Parameters

Body

Response