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 ‘module’ 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

{ "account": *** your account id ***, "apikey": "*** your api key ***", "action": "blueprint", "blueprint": "*** your broken blueprint ***", "syntaxcheckonly": true }

Sample Response

{ "success": false, "errormsg": "***details of blueprint errors***" }

Sample Request

{ "account": *** your account id ***, "apikey": "*** your api key ***", "action": "blueprint", "blueprint": "*** your valid blueprint ***", "syntaxcheckonly": true }

Sample Response

{ "success": true }

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

{ "account": *** your account id ***, "apikey": "*** your api key ***", "action": "blueprint", "blueprint": "*** your valid blueprint ***" }

Sample Response

{ "success": true }