Skip to content

Rippling: Create a new sandbox — request body — body config override

Create a new sandbox: request body, field body / config_override. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create a new sandbox — request body — body config override

FieldTypePresenceDescription and constraints
$objectRootType-specific sandbox configuration. Optional for developer sandboxes.
custom_objectsobjectOptionalCustom objects copied into the sandbox.
custom_objects.co_api_namesarrayOptionalCustom object API names copied into the sandbox.
custom_objects.co_api_names[]stringEach item
developerobjectOptionalRequired for developer sandboxes and omitted for full-data sandboxes.
developer.company_sizestringRequired within parentSeed company size for the developer sandbox. MEDIUM is the supported value for new sandboxes. SMALL is retained for existing sandboxes only and is not supported on create.
One of: SMALL, MEDIUM
general_notificationsModelOptionalExpand Create a new sandbox — request body — body config override general notifications
integrationsobjectOptionalRequired for connected full-data sandboxes.
integrations.is_risk_acknowledgedbooleanRequired within parentConfirms acceptance of the risks of connected third-party integrations.
sandbox_modestringOptionalRequired for full-data sandboxes. Developer sandboxes default to CONNECTED.
One of: CONNECTED, ISOLATED
workflow_webhooksobjectOptionalWorkflow webhook controls.
workflow_webhooks.allowed_ipsarrayOptionalIP addresses allowed to receive workflow webhooks.
workflow_webhooks.allowed_ips[]stringEach item
workflow_webhooks.allowlisted_webhook_urlsarrayOptionalWebhook URLs allowed in the sandbox.
workflow_webhooks.allowlisted_webhook_urls[]stringEach item
workflow_webhooks.outbound_behaviorstringOptionalWhether workflow webhook traffic is allowed or suppressed.
One of: SUPPRESS, ALLOW

Referenced models: Create a new sandbox — request body — body config override general notifications

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.