API - Apply a Blueprint
action - blueprint
Blueprints allow for the update of an account with records and configuration settings all in one place, rather than resorting to numerous individual add record calls. Typically, blueprints are maintained to contain an entire 'solution' of functionality to be added to an account all in one go, but there is no practical limit to the ways that configuration can be managed using multiple blueprints.
Full blueprint syntax and worked examples are discussed in the Blueprint help page.
Syntax Check
You can request a syntax check only – this will check the Blueprint and report any errors, but will not actually evaluate the Blueprint. If there are any problems, these will be described in errormsg
Sample Request
Sample Response
Sample Request
Sample Response
Load a Blueprint
Pass a valid Blueprint without the syntax check only flag and it will be evaluated against the account and configuration updated accordingly.
Sample Request
Sample Response
Other API Help Pages
Introduction
IntroductionActions
Read a Record | Update a Record | Add a Record | List Records | Evaluate a Template | Execute an Action Script | Apply a Blueprint | Get a Blueprint | Add a File | Get a File | Get/Set a Persistent Setting Value | Get Category Values | Get Group Memberships of a User | Get Members of a Group | Load Data | Get Metadata for a Record Type | Get Metadata on Calculation Functions | Trigger an Event | Get Usage Statistics | Validate a Calculation | Validate a Filter ExpressionDiscussion Topics
Linking Records | Automation - Automations and EventsReturn to Developer Help