ReferenceOrganization

Brand

4 operations. Send Authorization: Bearer $PASSBOOK_KEY. Markdown

GET/api/v1/brand
brand:manageSDK pb.brand.retrieve

Returns

200

Errors

CodeStatusFix
BRAND_IMAGE_NOT_FOUNDUpload the image with PUT /api/v1/orgs/{id}/branding/{slot} and use the URL it returns.
BRAND_MARK_NOT_ALLOWEDRemove the setting, or ask the platform owner to enable it for the organization.
ENTITLEMENTS_CHANGEDFetch them with GET /api/v1/orgs/{id}/entitlements and send your change again.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IDENTITY_NOT_FOUNDCheck the id with GET /api/v1/identities.
IMAGE_BYTESCompress the image and upload it again.
IMAGE_INVALIDExport a standard PNG and upload it again.
IMAGE_NOT_FOUNDUpload one with PUT /api/v1/orgs/{id}/branding/{slot}.
IMAGE_SCALEResize so the @2x image is two thirds of the @3x, then upload both.
IMAGE_SIZEResize to the size named in issues and upload it again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVITATION_INVALIDAsk an organization admin to send a new invitation with POST /api/v1/orgs/{id}/invitations.
INVITATION_PENDINGRevoke it to send a new one.
LAST_ORG_ADMINMake someone else an org admin first.
MEMBERSHIP_CONFLICTFetch it with GET /api/v1/orgs/{id}/memberships and send the change again.
MISSING_SCOPECreate a key with the scope the operation lists under security.
ORG_CONFLICTFetch it with GET /api/v1/orgs/{id} and send the change again.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_PERSONAL_SINGLE_MEMBERUse a regular organization to work with others.
ORG_SLUG_RESERVEDChoose a different slug.
ORG_SLUG_TAKENChoose a different slug.
ORG_STATUS_ALONESend the status change in its own request, then the other edits.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
SETTINGS_CHANGEDFetch them with GET /api/v1/settings and send your change again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
PATCH/api/v1/brand
brand:manageSDK pb.brand.update

Body

accentstring | null · ^#[0-9a-fA-F]{6}$
mark"full" | "small" | "none"
configRevisioninteger

Returns

200 Org

Errors

CodeStatusFix
BRAND_IMAGE_NOT_FOUNDUpload the image with PUT /api/v1/orgs/{id}/branding/{slot} and use the URL it returns.
BRAND_MARK_NOT_ALLOWEDRemove the setting, or ask the platform owner to enable it for the organization.
ENTITLEMENTS_CHANGEDFetch them with GET /api/v1/orgs/{id}/entitlements and send your change again.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IDENTITY_NOT_FOUNDCheck the id with GET /api/v1/identities.
IMAGE_BYTESCompress the image and upload it again.
IMAGE_INVALIDExport a standard PNG and upload it again.
IMAGE_NOT_FOUNDUpload one with PUT /api/v1/orgs/{id}/branding/{slot}.
IMAGE_SCALEResize so the @2x image is two thirds of the @3x, then upload both.
IMAGE_SIZEResize to the size named in issues and upload it again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVITATION_INVALIDAsk an organization admin to send a new invitation with POST /api/v1/orgs/{id}/invitations.
INVITATION_PENDINGRevoke it to send a new one.
LAST_ORG_ADMINMake someone else an org admin first.
MEMBERSHIP_CONFLICTFetch it with GET /api/v1/orgs/{id}/memberships and send the change again.
MISSING_SCOPECreate a key with the scope the operation lists under security.
ORG_CONFLICTFetch it with GET /api/v1/orgs/{id} and send the change again.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_PERSONAL_SINGLE_MEMBERUse a regular organization to work with others.
ORG_SLUG_RESERVEDChoose a different slug.
ORG_SLUG_TAKENChoose a different slug.
ORG_STATUS_ALONESend the status change in its own request, then the other edits.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
SETTINGS_CHANGEDFetch them with GET /api/v1/settings and send your change again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.

Web Logo

PUT/api/v1/brand/web-logo
brand:manageSDK pb.brand.webLogo.upload

Body

pngstring · max 699059Required
configRevisioninteger

Returns

200 Org

Errors

CodeStatusFix
BRAND_IMAGE_NOT_FOUNDUpload the image with PUT /api/v1/orgs/{id}/branding/{slot} and use the URL it returns.
BRAND_MARK_NOT_ALLOWEDRemove the setting, or ask the platform owner to enable it for the organization.
ENTITLEMENTS_CHANGEDFetch them with GET /api/v1/orgs/{id}/entitlements and send your change again.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IDENTITY_NOT_FOUNDCheck the id with GET /api/v1/identities.
IMAGE_BYTESCompress the image and upload it again.
IMAGE_INVALIDExport a standard PNG and upload it again.
IMAGE_NOT_FOUNDUpload one with PUT /api/v1/orgs/{id}/branding/{slot}.
IMAGE_SCALEResize so the @2x image is two thirds of the @3x, then upload both.
IMAGE_SIZEResize to the size named in issues and upload it again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVITATION_INVALIDAsk an organization admin to send a new invitation with POST /api/v1/orgs/{id}/invitations.
INVITATION_PENDINGRevoke it to send a new one.
LAST_ORG_ADMINMake someone else an org admin first.
MEMBERSHIP_CONFLICTFetch it with GET /api/v1/orgs/{id}/memberships and send the change again.
MISSING_SCOPECreate a key with the scope the operation lists under security.
ORG_CONFLICTFetch it with GET /api/v1/orgs/{id} and send the change again.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_PERSONAL_SINGLE_MEMBERUse a regular organization to work with others.
ORG_SLUG_RESERVEDChoose a different slug.
ORG_SLUG_TAKENChoose a different slug.
ORG_STATUS_ALONESend the status change in its own request, then the other edits.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
SETTINGS_CHANGEDFetch them with GET /api/v1/settings and send your change again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.
DEL/api/v1/brand/web-logo
brand:manageSDK pb.brand.webLogo.delete

Query

configRevisioninteger | null

Returns

200 Org

Errors

CodeStatusFix
BRAND_IMAGE_NOT_FOUNDUpload the image with PUT /api/v1/orgs/{id}/branding/{slot} and use the URL it returns.
BRAND_MARK_NOT_ALLOWEDRemove the setting, or ask the platform owner to enable it for the organization.
ENTITLEMENTS_CHANGEDFetch them with GET /api/v1/orgs/{id}/entitlements and send your change again.
FORBIDDENUse a key with the scope the operation lists, or ask an org admin.
IDENTITY_NOT_FOUNDCheck the id with GET /api/v1/identities.
IMAGE_BYTESCompress the image and upload it again.
IMAGE_INVALIDExport a standard PNG and upload it again.
IMAGE_NOT_FOUNDUpload one with PUT /api/v1/orgs/{id}/branding/{slot}.
IMAGE_SCALEResize so the @2x image is two thirds of the @3x, then upload both.
IMAGE_SIZEResize to the size named in issues and upload it again.
INVALID_API_KEYCreate a new key in the console and update PASSBOOK_KEY.
INVITATION_INVALIDAsk an organization admin to send a new invitation with POST /api/v1/orgs/{id}/invitations.
INVITATION_PENDINGRevoke it to send a new one.
LAST_ORG_ADMINMake someone else an org admin first.
MEMBERSHIP_CONFLICTFetch it with GET /api/v1/orgs/{id}/memberships and send the change again.
MISSING_SCOPECreate a key with the scope the operation lists under security.
ORG_CONFLICTFetch it with GET /api/v1/orgs/{id} and send the change again.
ORG_NOT_FOUNDCheck orgId with GET /api/v1/orgs.
ORG_PERSONAL_SINGLE_MEMBERUse a regular organization to work with others.
ORG_SLUG_RESERVEDChoose a different slug.
ORG_SLUG_TAKENChoose a different slug.
ORG_STATUS_ALONESend the status change in its own request, then the other edits.
RATE_LIMITEDWait for Retry-After seconds, then retry. Back off on repeats.
SETTINGS_CHANGEDFetch them with GET /api/v1/settings and send your change again.
UNAUTHENTICATEDSend Authorization: Bearer $PASSBOOK_KEY.
VALIDATIONFix each field in issues and resend.

Console only

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

PUT/api/v1/orgs/{id}/branding/{slot}Upload the pass logo or icon (@3x PNG; @2x derived)
DEL/api/v1/orgs/{id}/branding/{slot}Remove the pass logo or icon
GET/api/v1/orgs/{id}/branding/{slot}/{scale}Download the pass logo or icon
GET/api/v1/orgs/{id}/email-previewThe pass email as holders get it, with sample holder data (HTML)