Authorization

HTTPBearer

AuthorizationBearer <token>

In: header

Header Parameters

Members-Context?|

Members organization id (org_…) when the client has multiple organizations.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

Human-readable design title.

background_color?string

Background color as #RRGGBB.

Default"#000000"

Match^#[0-9A-Fa-f]{6}$

label_color?|

Label text color as #RRGGBB.

foreground_color?|

Foreground text color as #RRGGBB.

strip_color?|

Primary field text color overlaid on the strip image, as #RRGGBB. Used when layout includes a strip.

layout*string

Value in"strip_image" | "thumbnail_image"

strip_image_url?|

Public HTTPS URL of the strip/thumbnail image from a media upload (pass_strip_image). Optional for both layouts; omit for no image.

logo_url*string

Public HTTPS URL of the logo from a media upload (org_logo or pass_logo). Cannot be cleared on update.

logo_title?|

Text shown beside the logo.

header_field_label?|

Display label for the header field slot.

header_field?||

Member field binding for the header slot.

primary_field_label?|

Display label for the primary field slot.

primary_field?||

Member field binding for the primary slot.

secondary_fields?array<>

Ordered secondary field slots (max 8).

barcode_type?string

barcode_field?||

Member field binding encoded in the barcode.

show_barcode_alt_text?boolean

When true, show barcode value as alt text on supported wallets.

Defaultfalse

eligibility?|||

Who may use this design. active_members — any member with status active; products — member on an active or trialing subscription for any listed product; benefits — member with an active entitlement for any listed benefit. Omit while drafting; designs without eligibility are not issuable.

Response Body

`application/json`

curl -X POST "https://api.members.dev/v1/passes/designs" \  -H "Content-Type: application/json" \  -d '{    "title": "string",    "layout": "strip_image",    "logo_url": "string"  }'

{
  "title": "string",
  "background_color": "#000000",
  "label_color": "string",
  "foreground_color": "string",
  "strip_color": "string",
  "layout": "strip_image",
  "strip_image_url": "string",
  "logo_url": "string",
  "logo_title": "string",
  "header_field_label": "string",
  "header_field": {
    "kind": "system",
    "key": "name"
  },
  "primary_field_label": "string",
  "primary_field": {
    "kind": "system",
    "key": "name"
  },
  "secondary_fields": [
    {
      "label": "string",
      "field": {
        "kind": "system",
        "key": "name"
      }
    }
  ],
  "barcode_type": "none",
  "barcode_field": {
    "kind": "system",
    "key": "name"
  },
  "show_barcode_alt_text": false,
  "eligibility": {
    "type": "active_members"
  },
  "id": "string",
  "organization_id": "string",
  "archived_at": {},
  "created_at": null,
  "updated_at": null
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Pass Design

Authorization

Header Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`