ReferenceTemplates

Blueprints

1 operation. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

POST/api/v1/templates/{id}/use
templates:writeSDK pb.blueprints.use

Path

idstring · max 64Required

Body

orgIdstring · max 64Required
namestring · max 120Required
versionobject
passJsonobjectRequired
manifestobjectRequired
assetsobject | object[]
baseVersionstring · max 64

Returns

201 TemplateDetail

Errors

CodeStatusFix
ARCHIVE_TOO_LARGERemove unused files and upload an archive under 15 MB.
ASSETS_INVALIDFix the files named in issues and upload the archive again.
ASSET_NOT_FOUNDCheck the image name or id and that it belongs to this organization.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IMPORT_CONFLICTSend the request again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVALID_CURSORPass the nextCursor from the previous page unchanged, or drop it to start over.
INVALID_INPUTFix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them.
KEY_CREATOR_GONECreate a new key with POST /api/v1/api-keys.
KEY_CREATOR_NOT_MEMBERCreate a new key from a current member with POST /api/v1/api-keys.
KEY_TEST_ONLYUse a pb_test_ key.
MANIFEST_INVALIDFix the manifest fields listed in issues and upload it again.
MISSING_SCOPECreate a key with the scope the operation lists under security.
NOT_A_ZIPUpload the template as a .zip file.
NOT_FOUNDCheck the id, and that the key's mode (test or live) matches the object.
NO_FILESend the archive as multipart form data in the file field.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_REQUIREDSend orgId with the request, or use a key scoped to one organization.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
STAMPS_ABOVE_MAXRaise the template's stamp maximum, or redeem stamps first.
STAMPS_NONEUse a template with stamps.
STAMPS_QUERYRetry the request.
STAMPS_REDRAWMake the change in the template designer and publish a new version.
TEMPLATE_ARCHIVEDRestore it with POST /api/v1/templates/{id}/restore, or use another template.
TEMPLATE_ASSET_CONFLICTUpload the template version again.
TEMPLATE_BAKEDClone it with POST /api/v1/templates/{id}/clone and change the clone.
TEMPLATE_BLUEPRINT_INACTIVEPick another.
TEMPLATE_CANDIDATE_NOT_FOUNDCheck the id with GET /api/v1/templates/{id}/candidates.
TEMPLATE_CONFLICTFetch it with GET /api/v1/templates/{id} and send your change again.
TEMPLATE_CONTENT_CHANGEDSend the request again to use the current release.
TEMPLATE_EXISTSPick another name.
TEMPLATE_IN_USERemove it from them first.
TEMPLATE_IS_BLUEPRINTUse this blueprint to make one first.
TEMPLATE_MODE_MISMATCHUse a key of the template's mode.
TEMPLATE_NOT_BLUEPRINTDuplicate a template instead.
TEMPLATE_NOT_FOUNDCheck the id with GET /api/v1/templates and the key's mode.
TEMPLATE_NOT_SHAREABLEShare an upload that no organization has taken.
TEMPLATE_NOT_TESTEDRelease it in Test first.
TEMPLATE_ORG_REQUIREDAssign the template to an organization, then retry.
TEMPLATE_PROVIDER_UNSUPPORTEDConfigure the provider for the organization, or release for another provider.
TEMPLATE_RELEASE_CONFLICTSend the request again to use the current release.
TEMPLATE_RELEASE_NOT_FOUNDCheck the id with GET /api/v1/templates/{id}/releases.
TEMPLATE_RELEASE_REQUIREDApprove a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve.
TEMPLATE_SLUG_CONFLICTSend the request again, or choose a different name.
TEMPLATE_USED_BY_OTHER_ORGReissue or delete them first.
TEMPLATE_VERSION_CONFLICTFetch the template and publish again.
TEMPLATE_VERSION_CONTENT_CONFLICTRun the sync again.
TEMPLATE_VERSION_NOT_FOUNDCheck the version with GET /api/v1/templates/{id}.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
UPLOAD_NOT_FOUNDCheck the id with GET /api/v1/templates/uploads.
VALIDATIONFix each field in issues and resend.
VERSION_INVALIDUse a version number from GET /api/v1/templates/{id}.
WORKFLOW_STARTSend the request again.

Console only

Signed-in console sessions only. An API key cannot call these.

POST/api/v1/templates/{id}/use/checkCheck a designer draft made from a blueprint as the organization's template