Skip to content
vocapable.Docs

The company's reviewed sync plan for one CRM

GET
/v1/workspace/integrations/crm/{provider}/plan
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/integrations/crm/example/plan \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
provider
required
Provider
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceCrmSyncPlan

The company’s reviewed plan for one CRM (a draft until authorized and activated).

object
provider
required
Provider
string
Allowed values: hubspot salesforce pipedrive zoho
provider_name
required
Provider Name
string
installation_id
required
Any of:
string
installation_status
required
Any of:
string
revision
required
Any of:
integer
direction
required
Direction
string
Allowed values: two_way outbound inbound
conflict_owner
required
Conflict Owner
string
Allowed values: vocapable external
field_groups
required
Field Groups
Array<string>
Allowed values: name email owner stage activity
groups
required
Groups
Array<object>
WorkspaceCrmFieldGroupInfo
object
id
required
Id
string
Allowed values: name email owner stage activity
label
required
Label
string
target
required
Target
string
locked
required
Locked
boolean
pipeline
required
Any of:
string
stages
required
Stages
object
key
additional properties
string
reviewed_at
required
Any of:
string format: date-time
reviewed_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
rules
required
Rules
Array<string>
Example
{
  "provider": "hubspot",
  "direction": "two_way",
  "conflict_owner": "vocapable",
  "field_groups": [
    "name"
  ],
  "groups": [
    {
      "id": "name"
    }
  ]
}

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": {}
    }
  ]
}