> ## Documentation Index
> Fetch the complete documentation index at: https://docs.revcenter.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 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`.



## OpenAPI

````yaml /openapi.json post /projects/{projectId}/shortlist/email/preview
openapi: 3.1.0
info:
  title: Revcenter API
  version: v1
  description: >-
    Projects, searches, scored candidates and shortlists. Generated from the
    agent API's registry.
servers:
  - url: https://api.revcenter.ai/v1
security:
  - bearer: []
tags:
  - name: Login
  - name: Account
  - name: Actions
  - name: Reference
  - name: Projects
  - name: Searches
  - name: Scoring
  - name: Shortlists
  - name: Candidates
  - name: Webhooks
  - name: Health
paths:
  /projects/{projectId}/shortlist/email/preview:
    post:
      tags:
        - Shortlists
      summary: Preview the shortlist email
      description: >-
        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`.
      operationId: preview_shortlist_email
      parameters:
        - name: projectId
          in: path
          required: true
          description: A project id
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                client_workspace_id:
                  type: string
                  description: >-
                    The client workspace to email; defaults to the client portal
                    the project is assigned to.
            example:
              client_workspace_id: org_2xClIeNt
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              description: >-
                Requests allowed this minute (the tighter of the key's and the
                workspace's).
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left this minute.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: When the minute resets, in Unix seconds.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      client_workspace:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                      mode:
                        type: string
                        enum:
                          - test
                      send_to:
                        type: array
                        items:
                          type: string
                        description: Where it is actually sent.
                      intended_recipients:
                        type: array
                        items:
                          type: string
                        description: >-
                          The client workspace's members, who it would reach
                          live.
                      subject:
                        type: string
                      text:
                        type: string
                      url:
                        type:
                          - string
                          - 'null'
                      link_exists:
                        type: boolean
                      total:
                        type: integer
                      people:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            title:
                              type:
                                - string
                                - 'null'
                            company:
                              type:
                                - string
                                - 'null'
                            location:
                              type:
                                - string
                                - 'null'
                            linkedin_url:
                              type:
                                - string
                                - 'null'
                            score:
                              type:
                                - integer
                                - 'null'
                  meta:
                    $ref: '#/components/schemas/Meta'
              example:
                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

                    …
                  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
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Meta:
      type: object
      properties:
        request_id:
          type: string
        total:
          type: integer
          description: On lists that count everything that matched.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: 'Stable: every code is on the Errors page.'
            message:
              type: string
            details:
              type:
                - object
                - 'null'
              description: >-
                Structured specifics, when there are any (for example
                retry_after_seconds).
            request_id:
              type: string
        meta:
          $ref: '#/components/schemas/Meta'
      example:
        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
  responses:
    Error:
      description: 'An error: one envelope everywhere. A 429 carries Retry-After.'
      headers:
        X-RateLimit-Limit:
          description: >-
            Requests allowed this minute (the tighter of the key's and the
            workspace's).
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left this minute.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: When the minute resets, in Unix seconds.
          schema:
            type: integer
        Retry-After:
          description: Seconds to wait (on 429 and 503).
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key from Settings → Usage → API (rvc_live_…).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.