Request a warehouse build

POST

/internal/v2/system/build/warehouse/{facet}

Request a warehouse build

Parameters

Path Parameters

bucket

required

The bucket (client) name

string

Example

example

facet

required

string

Allowed values: attendance contact contact_large fundraising membership

The facet to build e.g. contact, membership

Query Parameters

force

If force is false the build will only run if the there are relevant changes since the last build.

boolean

safe_mode

If safe_mode is true, the build will be executed in a read only way.

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

function_name

string

message

string

params

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

object

bucket

string

force

boolean

safe_mode

boolean

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