Skip to content
vocapable.Docs

Estimate the credits to enrich the selected people (nothing is spent)

POST
/v1/workspace/integrations/apollo/enrichment-runs
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/integrations/apollo/enrichment-runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "people": [ { "id": "example", "name": "example", "title": "example", "company": "example" } ], "reveal_phone": false, "criteria": {} }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceApolloRunCreate
object
people
required
People
Array<object>
>= 1 items <= 25 items
WorkspaceApolloSelectedPerson
object
id
required
Id
string
>= 1 characters <= 64 characters
name
required
Name
string
<= 200 characters
title
Any of:
string
<= 200 characters
company
Any of:
string
<= 200 characters
reveal_phone
Reveal Phone
boolean
criteria
Criteria
object
key
additional properties
any

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceApolloRun
object
id
required
Id
string
installation_id
required
Installation Id
string
status
required
Status
string
Allowed values: estimated enriching awaiting_phones staged failed cancelled expired
reveal_phone
required
Reveal Phone
boolean
estimated_credits
required
Estimated Credits
integer
credit_balance
required
Any of:
integer
estimate_expires_at
required
Estimate Expires At
string format: date-time
confirmed_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
confirmed_at
required
Any of:
string format: date-time
people
required
People
Array<object>
WorkspaceApolloRunPerson
object
id
required
Id
string
name
required
Name
string
title
required
Any of:
string
company
required
Any of:
string
state
required
State
string
has_email
required
Has Email
boolean
has_phone
required
Has Phone
boolean
import_id
required
Any of:
string
error
required
Any of:
string
outreach_scheduled
Outreach Scheduled
integer
0
0
revision
required
Revision
integer
created_at
required
Created At
string format: date-time
Example
{
  "status": "estimated",
  "outreach_scheduled": 0
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}