Request Partner Sync

POST

/internal/v2/{bucket}/sync/{partner}/{action}/{data_type}

Request a sync with a partner

Parameters

Path Parameters

bucket

required

The bucket (client) name

string

Example

example

partner

required

string

Allowed values: clio eventbrite gocardless mailchimp mryum stripe

The partner to sync with e.g. mailchimp, gocardless, stripe

action

required

string

Allowed values: pull push

The action to perform e.g. pull, push

data_type

required

string

Allowed values: contacts consents events payments

The data type to sync e.g. contacts, payments

Query Parameters

since_hours

The number of hours to look back for changes e.g. 24 would look back 24 hours for changes

integer

default: 24

create_contacts

If the data_type is contacts, should new contacts be created?

boolean

full

Where supported a full sync will override the since_hours parameter

boolean

Responses

200

Details of the request. The output from the requested sync will appear in the usage reports with a summary of the results.

object

action

string

data_type

string

function_name

string

params

The parameters to pass to the lambda function which will execute your request

object

bucket

string

lambda_prefix

string

safe_mode

boolean

since_hours

The number of hours to look back for changes

integer

partner

string

status

OK if the request was successful

string

400

Bad request, see the error field for details

401

Unauthorized is the status code to return when the client provides no credentials or invalid credentials.

403

Forbidden is the status code to return when a client has valid credentials but not enough privileges to perform an action on a resource.

404

Not found

500

An error occurred within sheepCRM, please report to support@sheepcrm.com