SBC Setup API

Learn more about how to use the SBC Setup API to apply the Search Before Create setup in Veeva Vault CRM.

Use the SBC Setup API to set up Search Before Create in Veeva Vault CRM. This API creates or updates the HTML Report configuration, the SBC Config record, and the UI package.

HTTP method and endpoint

Use the following HTTP method and endpoint to submit the setup request.

POST https://{workato_api_base_url}/{environment}/veeva-sbc-vv1/veeva/sbc/setup

Request headers

Include the following request headers in every request.


Name	Required	Description
accept	Yes	Response media type. Use `application/json`.
Content-Type	Yes	Request media type. Use `multipart/form-data`.
API-TOKEN	Yes	API token from the Workato API collection client configuration for the SBC API.

Request body

The following table describes the request fields.


Field	Required	Description	Accepted values / Default
file	No	ZIP file that contains the UI configuration for Search Before Create.	Example: `sbc.zip`. If omitted, the API uses the most recent ZIP file stored under `SBC_setup_UI_zip_file`.
name__v	Yes	Name of the `html_report__v` record.	Example: `Test Page - SBC`
platform__v	Yes	Platform value for the `html_report__v` record.	Example: `online__v`
name__v_sbc_config__c	Yes	Name of the `sbc_config__c` record.	Example: `rec_token_test`
api_token__c_sbc_config__c	Yes	API token used for the Search Before Create import and search endpoints.	Example: `<api_token>`
test_mode__c_sbc_config__c	Yes	Indicates whether test mode is enabled for the import and search recipes.	`true` or `false`. Example: `false`
timeout_seconds__c_sbc_config__c	Yes	Timeout, in seconds, used by the import and search recipes.	Example: `30`

Example request

The following example shows a complete request with headers and request fields.

curl --location --request POST 'https://{workato_api_base_url}/{environment}/veeva-sbc-vv1/veeva/sbc/setup' \
--header 'accept: application/json' \
--header 'Content-Type: multipart/form-data' \
--header 'API-TOKEN: <api_token>' \
--form 'name__v=Test Page - SBC' \
--form 'platform__v=online__v' \
--form 'name__v_sbc_config__c=rec_token_test' \
--form 'api_token__c_sbc_config__c=<api_token>' \
--form 'test_mode__c_sbc_config__c=false' \
--form 'timeout_seconds__c_sbc_config__c=30' \
--form 'file=@sbc.zip'

Example response

The following example shows a successful response.

{
  "status": "success",
  "executionId": "9f4d7c2a-8b31-4f55-a8aa-2d9e9c1b7e41",
  "message": "SBC setup completed successfully.",
  "fileProcessed": true
}

Response fields

The following table describes the fields returned in the response body.


Field	Type	Description
status	String	Status returned for the setup request.
executionId	String	Unique identifier for the recipe execution.
message	String	Message returned for the request result.
fileProcessed	Boolean	Indicates whether the setup request processed a ZIP file.

Status codes

The API returns the following HTTP status codes based on the processing result.


Status code	Description
200	The setup request completed successfully.
400	No input file was available from the API request or file storage.
500	The setup request failed during processing. The response includes an error message and the job URL.

Unify and manage your data