ReferenceTemplates
Templates
19 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown
GET
/api/v1/templatesLists 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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
GET
/api/v1/templates/previewstemplates:readSDK pb.templates.listPreviews
Query
idsstringRequired
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
GET
/api/v1/templates/eligibletemplates: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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send 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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
POST
/api/v1/templates/{id}/previewtemplates:readSDK pb.templates.preview
Path
idstring · max 64Required
Body
versionstring
orgIdstring · max 64
inputobject
localestring · max 35
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
GET
/api/v1/templates/{id}/input-schemaReturns 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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
GET
/api/v1/templates/{id}/stamps-impacttemplates:readSDK pb.templates.retrieveStampsImpact
Path
idstring · max 64Required
Query
goalinteger · ≥ 3 · ≤ 20Required
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
POST
/api/v1/templates/{id}/scan-setupscanning:writeSDK pb.templates.setUpScanning
Path
idstring · max 64Required
Body
orgIdstring · max 64Required
timeZonestring · max 64
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
GET
/api/v1/templates/{id}/packagetemplates:readSDK pb.templates.downloadPackage
Path
idstring · max 64Required
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
Candidates
GET
/api/v1/templates/{id}/candidatestemplates: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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
POST
/api/v1/templates/{id}/candidatestemplates: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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
POST
/api/v1/templates/{id}/candidates/{candidateId}/approvetemplates: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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
Channels
GET
/api/v1/templates/{id}/channelstemplates:readSDK pb.templates.channels.retrieve
Path
idstring · max 64Required
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
GET
/api/v1/templates/{id}/channels/runstemplates:readSDK pb.templates.channels.listRuns
Path
idstring · max 64Required
Returns
200
Errors
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
Releases
GET
/api/v1/templates/{id}/releasestemplates: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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
POST
/api/v1/templates/{id}/releasestemplates: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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send the request again. |
GET
/api/v1/templates/{id}/releases/impacttemplates: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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send 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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send 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
| Code | Status | Fix |
|---|---|---|
| ARCHIVE_TOO_LARGE | Remove unused files and upload an archive under 15 MB. | |
| ASSETS_INVALID | Fix the files named in issues and upload the archive again. | |
| ASSET_NOT_FOUND | Check the image name or id and that it belongs to this organization. | |
| FORBIDDEN | Use a key with the scope the operation lists, or ask an org admin. | |
| IMPORT_CONFLICT | Send the request again. | |
| INVALID_API_KEY | Create a new key in the console and update PASSBOOK_KEY. | |
| INVALID_CURSOR | Pass the nextCursor from the previous page unchanged, or drop it to start over. | |
| INVALID_INPUT | Fix the inputs named in issues; GET /api/v1/templates/{id}/input-schema lists them. | |
| KEY_CREATOR_GONE | Create a new key with POST /api/v1/api-keys. | |
| KEY_CREATOR_NOT_MEMBER | Create a new key from a current member with POST /api/v1/api-keys. | |
| KEY_TEST_ONLY | Use a pb_test_ key. | |
| MANIFEST_INVALID | Fix the manifest fields listed in issues and upload it again. | |
| MISSING_SCOPE | Create a key with the scope the operation lists under security. | |
| NOT_A_ZIP | Upload the template as a .zip file. | |
| NOT_FOUND | Check the id, and that the key's mode (test or live) matches the object. | |
| NO_FILE | Send the archive as multipart form data in the file field. | |
| ORG_NOT_FOUND | Check orgId with GET /api/v1/orgs. | |
| ORG_REQUIRED | Send orgId with the request, or use a key scoped to one organization. | |
| RATE_LIMITED | Wait for Retry-After seconds, then retry. Back off on repeats. | |
| STAMPS_ABOVE_MAX | Raise the template's stamp maximum, or redeem stamps first. | |
| STAMPS_NONE | Use a template with stamps. | |
| STAMPS_QUERY | Retry the request. | |
| STAMPS_REDRAW | Make the change in the template designer and publish a new version. | |
| TEMPLATE_ARCHIVED | Restore it with POST /api/v1/templates/{id}/restore, or use another template. | |
| TEMPLATE_ASSET_CONFLICT | Upload the template version again. | |
| TEMPLATE_BAKED | Clone it with POST /api/v1/templates/{id}/clone and change the clone. | |
| TEMPLATE_BLUEPRINT_INACTIVE | Pick another. | |
| TEMPLATE_CANDIDATE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/candidates. | |
| TEMPLATE_CONFLICT | Fetch it with GET /api/v1/templates/{id} and send your change again. | |
| TEMPLATE_CONTENT_CHANGED | Send the request again to use the current release. | |
| TEMPLATE_EXISTS | Pick another name. | |
| TEMPLATE_IN_USE | Remove it from them first. | |
| TEMPLATE_IS_BLUEPRINT | Use this blueprint to make one first. | |
| TEMPLATE_MODE_MISMATCH | Use a key of the template's mode. | |
| TEMPLATE_NOT_BLUEPRINT | Duplicate a template instead. | |
| TEMPLATE_NOT_FOUND | Check the id with GET /api/v1/templates and the key's mode. | |
| TEMPLATE_NOT_SHAREABLE | Share an upload that no organization has taken. | |
| TEMPLATE_NOT_TESTED | Release it in Test first. | |
| TEMPLATE_ORG_REQUIRED | Assign the template to an organization, then retry. | |
| TEMPLATE_PROVIDER_UNSUPPORTED | Configure the provider for the organization, or release for another provider. | |
| TEMPLATE_RELEASE_CONFLICT | Send the request again to use the current release. | |
| TEMPLATE_RELEASE_NOT_FOUND | Check the id with GET /api/v1/templates/{id}/releases. | |
| TEMPLATE_RELEASE_REQUIRED | Approve a release with POST /api/v1/templates/{id}/candidates/{candidateId}/approve. | |
| TEMPLATE_SLUG_CONFLICT | Send the request again, or choose a different name. | |
| TEMPLATE_USED_BY_OTHER_ORG | Reissue or delete them first. | |
| TEMPLATE_VERSION_CONFLICT | Fetch the template and publish again. | |
| TEMPLATE_VERSION_CONTENT_CONFLICT | Run the sync again. | |
| TEMPLATE_VERSION_NOT_FOUND | Check the version with GET /api/v1/templates/{id}. | |
| UNAUTHENTICATED | Send Authorization: Bearer $PASSBOOK_KEY. | |
| UPLOAD_NOT_FOUND | Check the id with GET /api/v1/templates/uploads. | |
| VALIDATION | Fix each field in issues and resend. | |
| VERSION_INVALID | Use a version number from GET /api/v1/templates/{id}. | |
| WORKFLOW_START | Send 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 draftPUT
/api/v1/templates/{id}/manifestSave the manifest as an inactive versionPUT
/api/v1/templates/{id}/channelsSet a template's channels to on, off or never; dryRun shows the effectPOST
/api/v1/templates/{id}/versionsSave an inactive version from JSON; dryRun only validates and buildsPOST
/api/v1/templates/{id}/archiveArchive an uploaded templatePOST
/api/v1/templates/{id}/restoreRestore an archived template that never had a releasePOST
/api/v1/templates/{id}/candidates/promotePromote a version released in Test to a Live candidatePOST
/api/v1/templates/{id}/releases/rollbackRoll back to a prior template release