Save the reviewed sync plan (direction, field groups, conflict owner, stages)

PUT

/v1/workspace/integrations/crm/{provider}/plan

curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/integrations/crm/example/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "direction": "two_way", "conflict_owner": "vocapable", "field_groups": [ "name" ], "pipeline": "example", "stages": { "additionalProperty": "example" }, "reviewed": true, "expected_revision": 1 }'

Authorizations

• HTTPBearer

Parameters

Path Parameters

provider

required

Provider

string

Request Body^required

Media typeapplication/json

WorkspaceCrmSyncPlanUpdate

object

direction

required

Direction

string

Allowed values: two_way outbound inbound

conflict_owner

Conflict Owner

string

default: vocapable

Allowed values: vocapable external

field_groups

required

Field Groups

Array<string>

>= 1 items

Allowed values: name email owner stage activity

pipeline

Any of:

string

string

<= 200 characters

null

null

stages

Stages

object

key

additional properties

string

reviewed

required

Reviewed

boolean

expected_revision

Any of:

integer

integer

null

null

Responses

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

string

null

null

installation_status

required

Any of:

string

string

null

null

revision

required

Any of:

integer

integer

null

null

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

string

null

null

stages

required

Stages

object

key

additional properties

string

reviewed_at

required

Any of:

string

string format: date-time

null

null

reviewed_by

required

Any of:

WorkspacePersonRef

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

null

null

rules

required

Rules

Array<string>

Example

{
  "provider": "hubspot",
  "direction": "two_way",
  "conflict_owner": "vocapable",
  "field_groups": [
    "name"
  ],
  "groups": [
    {
      "id": "name"
    }
  ]
}

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}