Skip to content

Rippling: Deploy a metadata component package — response body — installations item

Deploy a metadata component package: response body, field installations / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Deploy a metadata component package — response body — installations item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
identifierobjectRequired within parentInstalled component identifier.
Additional keys: allowed
navigation_targetJSONOptional
navigation_target (anyOf 1)objectAlternativeNavigation target for the installed component, when available.
navigation_target (anyOf 1).target_typestringRequired within parentType of UI target.
navigation_target (anyOf 1).titlestringRequired within parentDisplay title for the navigation target.
navigation_target (anyOf 1).urlstringRequired within parentRelative URL for the installed component.
navigation_target (anyOf 2)nullAlternative
resultobjectOptionalType-specific install result.
Additional keys: allowed
statusstringRequired within parentPer-component install result.
Known values: SUCCESS, FAILED, SKIPPED_ALREADY_EXISTS, UPDATED, SKIPPED_NO_CHANGES
typestringRequired within parentMetadata component type.

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.