ReferenceTemplates

Templates

19 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

GET/api/v1/templates

Lists the organization's templates, newest first. Use blueprint=1 for starters.

templates:readSDK pb.templates.list

Query

includeArchived"0" | "1" | "true" | "false"
origin"baked" | "uploaded"
blueprint"0" | "1" | "true" | "false"
status"active" | "archived"
qstring · max 100
cursorstring
limitinteger · ≥ 1 · ≤ 200

Returns

200 TemplatePage

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.
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.
GET/api/v1/templates/previews
templates:readSDK pb.templates.listPreviews

Query

idsstringRequired

Returns

200

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.
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.
GET/api/v1/templates/eligible
templates:readSDK pb.templates.listEligible

Query

mode"live" | "test"Required
provider"apple" | "google" | "samsung"Required
purpose"issue" | "scan"
cursorstring · max 64
limitinteger · ≥ 1 · ≤ 200

Returns

200

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.
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.
GET/api/v1/templates/{id}

One template with its versions and a sample input. sample is a valid input for creating a pass.

templates:readSDK pb.templates.retrieve

Path

idstring · max 64Required

Returns

200 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.
POST/api/v1/templates/{id}/preview
templates:readSDK pb.templates.preview

Path

idstring · max 64Required

Body

versionstring
orgIdstring · max 64
inputobject
localestring · max 35

Returns

200

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.
GET/api/v1/templates/{id}/input-schema

Returns the JSON Schema that input must satisfy in POST /passes for this template's active version. Field labels, groups and order are in the x-label, x-group and x-order keywords. Use it to build a form or generate types.

templates:readSDK pb.templates.retrieveInputSchema

Path

idstring · max 64Required

Returns

200 TemplateInputSchema

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.
GET/api/v1/templates/{id}/stamps-impact
templates:readSDK pb.templates.retrieveStampsImpact

Path

idstring · max 64Required

Query

goalinteger · ≥ 3 · ≤ 20Required

Returns

200

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.
POST/api/v1/templates/{id}/scan-setup
scanning:writeSDK pb.templates.setUpScanning

Path

idstring · max 64Required

Body

orgIdstring · max 64Required
timeZonestring · max 64

Returns

200

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.
GET/api/v1/templates/{id}/package
templates:readSDK pb.templates.downloadPackage

Path

idstring · max 64Required

Returns

200

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.

Candidates

GET/api/v1/templates/{id}/candidates
templates:readSDK pb.templates.candidates.list

Path

idstring · max 64Required

Query

mode"live" | "test"Required
provider"apple" | "google" | "samsung"Required
cursorstring · max 512

Returns

200

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.
POST/api/v1/templates/{id}/candidates
templates:writeSDK pb.templates.candidates.create

Path

idstring · max 64Required

Body

orgIdstring · max 64Required
mode"live" | "test"Required
provider"apple" | "google" | "samsung"Required
versionstringRequired
sourceReleaseIdstring · max 64
projectionany

Returns

201

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.
POST/api/v1/templates/{id}/candidates/{candidateId}/approve
templates:reviewSDK pb.templates.candidates.approve

Path

idstring · max 64Required
candidateIdstring · max 64Required

Body

orgIdstring · max 64Required
mode"live" | "test"Required
provider"apple" | "google" | "samsung"Required
candidateHashstringRequired
aloneboolean

Returns

201

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.

Channels

GET/api/v1/templates/{id}/channels
templates:readSDK pb.templates.channels.retrieve

Path

idstring · max 64Required

Returns

200

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.
GET/api/v1/templates/{id}/channels/runs
templates:readSDK pb.templates.channels.listRuns

Path

idstring · max 64Required

Returns

200

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.

Releases

GET/api/v1/templates/{id}/releases
templates:readSDK pb.templates.releases.list

Path

idstring · max 64Required

Query

mode"live" | "test"Required
provider"apple" | "google" | "samsung"Required
cursorstring · max 512

Returns

200

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.
POST/api/v1/templates/{id}/releases
templates:publishSDK pb.templates.releases.create

Path

idstring · max 64Required

Body

orgIdstring · max 64Required
mode"live" | "test"Required
provider"apple" | "google" | "samsung"Required
candidateIdstring · max 64Required
approvalIdstring · max 64Required
candidateHashstringRequired
expectedGenerationinteger · ≥ 0Required

Returns

201

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.
GET/api/v1/templates/{id}/releases/impact
templates:readSDK pb.templates.releases.retrieveImpact

Path

idstring · max 64Required

Query

mode"live" | "test"Required
provider"apple" | "google" | "samsung"Required
versionstring · max 64Required

Returns

200

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.

Versions

GET/api/v1/templates/{id}/versions/{version}
templates:readSDK pb.templates.versions.retrieve

Path

idstring · max 64Required
versionstring · max 64Required

Returns

200

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.
GET/api/v1/templates/{id}/versions/{version}/assets/{name}
templates:readSDK pb.templates.versions.downloadAsset

Path

idstring · max 64Required
versionstring · max 64Required
namestring · max 200Required

Query

stampsinteger | null · ≥ 0 · ≤ 20

Returns

200

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.

DEL/api/v1/templates/{id}Delete or archive an uploaded template (baked: 403 TEMPLATE_BAKED)
POST/api/v1/templates/{id}/cloneClone into an inactive uploaded draft
PUT/api/v1/templates/{id}/manifestSave the manifest as an inactive version
PUT/api/v1/templates/{id}/channelsSet a template's channels to on, off or never; dryRun shows the effect
POST/api/v1/templates/{id}/versionsSave an inactive version from JSON; dryRun only validates and builds
POST/api/v1/templates/{id}/archiveArchive an uploaded template
POST/api/v1/templates/{id}/restoreRestore an archived template that never had a release
POST/api/v1/templates/{id}/candidates/promotePromote a version released in Test to a Live candidate
POST/api/v1/templates/{id}/releases/rollbackRoll back to a prior template release