Important: If you are entering a live acquistion_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a person being added to the live campaign.
Important: If you are entering a live broadcast_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in changes being made to the live broadcast.
Important: If you are entering a live broadcast_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in the live broadcast being canceled.
Important: If you are entering a live event_triggered_message_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in changes being made to the live campaign.
Important: If you are entering a live event_triggered_message_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in the live campaign being deleted.
Important: If you are entering a live issuance_pool_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a code being issued.
Important: If you are entering a real incentive_code, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a code being redeemed.
- When using an invalid issuee_id or external_issuee_id.
- When using a \"unique\" pool type, and the code has already been redeemed.
"
}
}
},
"get": {
"tags": [
"Incentive Code API"
],
"summary": "Get redemptions for a code",
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"schema": {
"type": "string",
"default": 1
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
},
"example": "application/json",
"required": true
},
{
"name": "company_key",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "incentive_code",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/incentiveCodeIssuancesResponse"
}
}
}
}
}
}
},
"/companies/{company_key}/incentives/pools": {
"get": {
"tags": [
"Incentive Pool API"
],
"summary": "Get incentive pools",
"parameters": [
{
"name": "company_key",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/incentivePoolsResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Incentive Pool API"
],
"summary": "Create a new code pool",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/incentivePoolRequest"
}
}
}
},
"parameters": [
{
"name": "X-API-VERSION",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
},
"example": "application/json",
"required": true
},
{
"name": "company_key",
"in": "path",
"schema": {
"type": "string"
},
"required": true,
"description": "Important: Please note that the \"Try It\" feature to the right will send an actual API call to our system, which may result in a new code pool being created.
Important: If you are entering a live incentive_pool_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in changes being made to the live code pool.
Important: If you are entering a real person_key, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a person record being updated.
Important: If you are entering a real external_person_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a person record being updated.
Important: Please note that the \"Try It\" feature to the right will send an actual API call to our system, which may result in a new person record being created.
Important: If you are entering a real vibes_device_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a person being associated with a push device.
Important: If you are entering a real person_key, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a person being unsubscribed.
Important: If you are entering a real external_person_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a person being unsubscribed.
Required if searching by mdn.",
"schema": {
"type": "string"
}
},
{
"name": "person_key",
"in": "query",
"description": "A unique Vibes-asigned alphanumeric identifier for each person record.
Required if searching by `person_key`.",
"schema": {
"type": "string"
}
},
{
"name": "external_person_id",
"in": "query",
"description": "A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records.
Required if searching by `external_person_id`.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/personResponse"
}
}
}
},
"404": {
"description": "The subscriber cannot be located or they are not subscribed to the specified list."
}
}
}
},
"/companies/{company_key}/mobiledb/subscription_lists/": {
"get": {
"tags": [
"Subscription List API"
],
"summary": "Get subscription lists",
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"schema": {
"type": "string",
"default": 1
}
},
{
"name": "company_key",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subscriptionListsResponse"
}
}
}
}
}
}
},
"/companies/{company_key}/mobiledb/subscription_lists/{subscription_list_id}": {
"get": {
"tags": [
"Subscription List API"
],
"summary": "Get subscription list info",
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"schema": {
"type": "string",
"default": 1
}
},
{
"name": "company_key",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "subscription_list_id",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subscriptionListResponse"
}
}
}
},
"404": {
"description": "The `subscription_list_id` cannot be found."
}
}
}
},
"/companies/{company_key}/mobiledb/subscription_lists/{subscription_list_id}/acquisition_campaigns/": {
"get": {
"tags": [
"Subscription List API"
],
"summary": "Get acquisition campaigns for subscription list",
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"schema": {
"type": "string",
"default": 1
}
},
{
"name": "company_key",
"in": "path",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "subscription_list_id",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/acquisitionsResponse"
}
}
}
},
"404": {
"description": "The `subscription_list_id` cannot be found."
}
}
}
},
"/companies/{company_key}/campaigns/wallet": {
"get": {
"tags": [
"Wallet Campaign API"
],
"summary": "Get wallet campaigns",
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"schema": {
"type": "string",
"default": 1
}
},
{
"name": "company_key",
"in": "path",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/walletCampaignsResponse"
}
}
}
},
"404": {
"description": "No mobile wallet campaigns are located."
}
}
},
"post": {
"tags": [
"Wallet Campaign API"
],
"summary": "Create a wallet campaign",
"description": "Create a new mobile wallet campaign. The campaign `type` determines the kind of pass it issues (`offer`, `loyalty`, or `event_ticket`) and cannot be changed after creation.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/walletCampaignRequest"
}
}
}
},
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"schema": {
"type": "string",
"default": 1
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string"
},
"example": "application/json",
"required": true
},
{
"name": "company_key",
"in": "path",
"schema": {
"type": "string"
},
"required": true,
"description": "Important: Using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a wallet campaign being created.
Important: If you are entering a real wallet_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a wallet campaign being updated.
Important: If you are entering a real wallet_item_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a wallet being updated.
Important: If you are entering a real wallet_id, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a wallet message being created and sent.
Important: If you are entering a real wallet token, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a wallet template being created.
Important: If you are entering a real wallet token, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a wallet template being updated.
Important: If you are entering a real wallet token, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a wallet template being created.
Important: If you are entering a real wallet token, please note that using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a wallet template being updated.
Important: Using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a location selector being created.
Important: Using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a location selector being updated.
Important: Using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a location selector being deleted.
Important: Using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in store locations being created.
Important: Using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in a store location being deleted.
Important: Using the \"Try It\" feature on the righthand console will send an actual API call to our system. This may result in store locations being deleted.
IMPORTANT - If you are sending both text and image, you must select ADD + twice to add separate objects for each. Selecting ADD + just once will result in only one element of your MMS being added.",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/mmsurl"
},
{
"$ref": "#/components/schemas/mmstext"
}
]
}
}
},
"required": [
"sourcecode",
"country_code",
"sourcecode_type",
"content"
]
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": "Any filters used to target recipients.",
"properties": {
"name": {
"type": "string",
"description": "The name of the filter you are using. Use \"subscription\" for subscription list."
},
"transform": {
"type": "string",
"description": "The transform element is used to transform the value of the custom field into a value. For example, the transform 'month' changes a custom value into just a month value. If the value was the date 2023-10-17, the transform would change the value to 10."
},
"selector": {
"type": "string",
"description": "Use any to filter in the values. Use none to filter out values."
},
"value": {
"type": "array",
"description": "Select ADD+ once per value.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/filters-number"
},
{
"$ref": "#/components/schemas/filters-string"
}
]
}
}
}
}
}
},
"required": [
"mms",
"channel"
]
}
},
"required": [
"name",
"event_type",
"start_date",
"targeting"
]
},
"eventTriggeredRequestPush": {
"type": "object",
"title": "Select for Push",
"properties": {
"name": {
"type": "string"
},
"event_type": {
"type": "string"
},
"start_date": {
"type": "string",
"example": "yyyy-mm-dd",
"format": "date"
},
"end_date": {
"type": "string",
"example": "yyyy-mm-dd",
"format": "date"
},
"targeting": {
"type": "object",
"properties": {
"message_template": {
"type": "string",
"description": "Template for your message content. May include valid Liquid personalization tags."
},
"short_url_base": {
"type": "string",
"description": "If you have a custom short domain, enter it here."
},
"shorten_urls": {
"type": "boolean",
"description": "Should URLs be shortened?"
},
"channel": {
"type": "string",
"enum": [
"push"
]
},
"push": {
"type": "object",
"properties": {
"mdn_territory": {
"type": "string"
},
"app_id": {
"type": "string",
"description": "Vibes-specific UUID for the your app."
},
"silent_push": {
"type": "boolean",
"description": "Select \"true\" if you'd like the customer to not recieve a visible message to the customer. Default is \"false.\""
},
"subject": {
"type": "string",
"description": "Subject line displayed in a push message."
},
"media_url": {
"type": "string",
"description": "Requires Rich Media support in the operating system and device hardware."
},
"sound": {
"type": "string",
"description": "The notification sound defaults to silent. Custom sounds must be built into the app."
},
"badge": {
"type": "string",
"description": "Reset the total badge value on the app icon."
},
"metadata": {
"type": "string"
},
"client_custom_data": {
"type": "string"
},
"collapse_id": {
"type": "string",
"description": "Identical collapse_id values on two notifications will allow a previous notification to be replaced with an incoming notification. iOS only."
},
"category": {
"type": "string",
"description": "Notification channel, aka category, is used to group certain types of notifications together. Android 8+ only."
},
"expiration_offset": {
"type": "number",
"description": "How long (in miliseconds) Apple or Google will attempt to send the message if the device is offline, up to 28 days."
}
},
"required": [
"app_id"
]
},
"filters": {
"type": "array",
"items": {
"type": "object",
"description": "Any filters used to target recipients.",
"properties": {
"name": {
"type": "string",
"description": "The name of the filter you are using. Use \"subscription\" for subscription list."
},
"transform": {
"type": "string",
"description": "The transform element is used to transform the value of the custom field into a value. For example, the transform 'month' changes a custom value into just a month value. If the value was the date 2023-10-17, the transform would change the value to 10."
},
"selector": {
"type": "string",
"description": "Use any to filter in the values. Use none to filter out values."
},
"value": {
"type": "array",
"description": "Select ADD+ once per value.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/filters-number"
},
{
"$ref": "#/components/schemas/filters-string"
}
]
}
}
}
}
}
},
"required": [
"push",
"message_template",
"channel"
]
}
},
"required": [
"name",
"event_type",
"start_date",
"targeting"
]
},
"incentivePoolResponse": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Vibes unique identifier for each incentive pool."
},
"name": {
"type": "string",
"description": "The name of the incentive pool."
},
"issuance_allowed": {
"type": "boolean",
"description": "Indicates whether codes are currently allowed to be issued from this code pool."
},
"redemption_allowed": {
"type": "boolean",
"description": "Indicates whether codes from this code pool are currently allowed to be redeemed."
},
"incentive_codes": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of incentive codes in the pool."
},
"issued": {
"type": "integer",
"description": "Total number of incentive codes from the pool that have been issued."
},
"remaining": {
"type": "integer",
"description": "Number of incentive codes in the pool that are still available to be issued."
},
"low_threshold": {
"type": "integer",
"description": "Set a number at which you'd like to be notified to add more codes to your pool."
},
"max_charachters": {
"type": "integer",
"description": "The maximum number of characters allowed in an incentive code in this pool."
}
}
},
"distribution": {
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "The method of distribution (unique|multi)."
}
}
},
"notification_email_address": {
"type": "string",
"description": "The email address you'd like notifications about this code pool to be send to."
},
"created_at": {
"type": "string",
"description": "The date this pool was created in ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "The date this pool was last updated in ISO-8601 format."
},
"url": {
"type": "string"
}
}
},
"incentivePoolsResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/incentivePoolResponse"
}
},
"incentivePoolRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name given to the incentive pool."
},
"issuance_allowed": {
"type": "boolean",
"description": "Indicates whether codes are currently allowed to be issued from this code pool."
},
"redemption_allowed": {
"type": "boolean",
"description": "Indicates whether codes from this code pool are currently allowed to be redeemed."
},
"incentive_codes": {
"type": "object",
"properties": {
"low_threshold": {
"type": "integer",
"description": "The number of remaining incentive codes where a notification is sent."
},
"max_characters": {
"type": "integer",
"description": "The maximum number of characters allowed in an incentive code in this pool."
}
},
"required": [
"low_threshold",
"max_characters"
]
},
"distribution": {
"type": "object",
"properties": {
"method": {
"type": "string",
"description": "The method of distribution.",
"enum": [
"unique",
"multi"
]
}
}
},
"notification_email_address": {
"type": "string",
"description": "The email address for all notifications."
}
},
"required": [
"name",
"issuance_allowed",
"redemption_allowed",
"incentive_codes",
"distribution",
"notification_email_address"
]
},
"incentiveCodeResponse": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The incentive code."
},
"active": {
"type": "boolean",
"description": "Whether issuance of the incentive code is currently allowed."
},
"issuances": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of times this code has been issued."
},
"unique": {
"type": "integer",
"description": "The number of unique times this code has been issued."
}
}
},
"redemptions": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "The total number of times this code has been redeemed."
},
"unique": {
"type": "integer",
"description": "The number of unique times this code has been redeemed."
}
}
},
"created_at": {
"type": "string",
"description": "The date this code was created, in the ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "The date this code was last updated, in the ISO-8601 format."
},
"url": {
"type": "string"
}
}
},
"incentiveCodeIssuanceRequest": {
"type": "object",
"properties": {
"external_issuee_id": {
"type": "string",
"description": "Unique external issuee ID."
},
"code": {
"type": "string",
"description": "If provided, this specific code is issued."
},
"referring_application": {
"type": "string",
"description": "Application issuing the code. Required in pools requiring a campaign_registration."
},
"referring_application_ref_id": {
"type": "string",
"description": "Application reference ID. Required in pools requiring a campaign_registration."
}
}
},
"incentiveCodeIssuanceResponse": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Vibes unique identifier for each issuance."
},
"external_issuee_id": {
"type": "string",
"description": "Unique external issuee ID."
},
"issuee_id": {
"type": "string",
"description": "Vibes generated issuee ID."
},
"referring_application": {
"type": "string",
"description": "Application issuing the code."
},
"referring_application_ref_id": {
"type": "string",
"description": "Application reference ID (campaign ID)."
},
"incentive_code": {
"type": "object",
"description": "An object describing this Issuance's Incentive Code.",
"properties": {
"code": {
"type": "string",
"description": "The incentive code."
},
"url": {
"type": "string",
"description": "The incentive code's resource URL."
}
}
},
"incentive_pool": {
"type": "object",
"description": "An object describing this issuance's Pool.",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier for the pool."
},
"url": {
"type": "integer",
"description": "The URL to access the incentive pool resource."
}
}
},
"created_at": {
"type": "string",
"description": "The date this issuance was created, in the ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "The date this issuance was last updated, in the ISO-8601 format."
}
}
},
"incentiveCodeIssuancesResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/incentiveCodeIssuanceResponse"
}
},
"personResponse": {
"type": "object",
"properties": {
"person_key": {
"type": "string",
"description": "A unique Vibes-asigned alphanumeric identifier for each person record."
},
"external_person_id": {
"type": "string",
"description": "A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records. Max 128 characters."
},
"mobile_phone": {
"type": "object",
"description": "Object representation of a person's mobile phone. A person can have only one active mobile phone at a time.",
"properties": {
"mdn": {
"type": "string",
"description": "Mobile Directory Number. The dialable phone number associated with the phone."
},
"carrier_code": {
"type": "string",
"description": "The cellular carrier associated with this mobile number."
}
}
},
"custom_fields": {
"type": "object",
"description": "list of custom field key/value pairs.",
"additionalProperties": {
"type": "string"
}
},
"created_at": {
"type": "string",
"description": "The date this person was created, in the ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "The date this person was last updated, in the ISO-8601 format."
},
"url": {
"type": "string"
}
}
},
"personsResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/personResponse"
}
},
"personRequest": {
"type": "object",
"properties": {
"external_person_id": {
"type": "string",
"description": "A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records. Max 128 characters."
},
"mobile_phone": {
"type": "object",
"description": "Object representation of a person's mobile phone. A person can have only one active mobile phone at a time.",
"properties": {
"mdn": {
"type": "string",
"description": "Mobile Directory Number. The dialable phone number associated with the phone."
},
"carrier_code": {
"type": "string",
"description": "The cellular carrier associated with this mobile number."
}
}
},
"custom_fields": {
"type": "object",
"description": "List of custom field key/value pairs.",
"additionalProperties": {
"type": "string"
}
}
}
},
"pushDeviceResponse": {
"type": "object",
"properties": {
"vibes_device_id": {
"type": "string",
"description": "Vibes unique identifier for each device."
},
"OS": {
"type": "string",
"description": "Operating system of the push device (Android or iOS)."
},
"os_version": {
"type": "string",
"description": "Version of the operating system."
},
"sdk_version": {
"type": "string",
"description": "Version of the Vibes Push SDK."
},
"app_version": {
"type": "string",
"description": "Version of the mobile app."
},
"push_token": {
"type": "string",
"description": "Android or IOS push token."
},
"hardware_make": {
"type": "string",
"description": "Make of the mobile device."
},
"hardware_model": {
"type": "string",
"description": "Model of the mobile device."
},
"advertising_id": {
"type": "string",
"description": "Advertising ID (optional)."
},
"locale": {
"type": "string",
"description": "Locale (Language/Time Zone) of the device."
},
"location": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "Last known latitude of the mobile device (optional)."
},
"longitude": {
"type": "number",
"description": "Last known longitude of the mobile device (optional)."
}
}
},
"timezone": {
"type": "string",
"description": "Timezone that is set on the mobile device."
},
"url": {
"type": "string"
}
}
},
"pushDevicesResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/pushDeviceResponse"
}
},
"assignPushDeviceRequest": {
"type": "object",
"description": "One of external_person_id OR person_key is required.",
"properties": {
"external_person_id": {
"type": "string",
"description": "A unique person identifier assigned by the brand, which can be used to link non-Vibes-assigned identifiers to Vibes person records."
},
"person_key": {
"type": "string",
"description": "A unique Vibes-asigned alphanumeric identifier for each person record."
}
}
},
"sourceCodeResponse": {
"type": "object",
"properties": {
"sourcecode": {
"type": "string",
"description": "The short, long or alphanumeric code value."
},
"country_code": {
"type": "string",
"description": "The E.164 Country Calling Code for the country where the code is provisioned."
},
"sourcecode_type": {
"type": "string",
"description": "SC for short or long numeric codes; ANC for alphanumeric codes.",
"enum": [
"SC",
"ANC"
]
},
"primary_country_name": {
"type": "string",
"description": "A human-readable name of the primary country where the code is provisioned."
},
"sms_enabled": {
"type": "boolean",
"description": "Indicates whether the code is provisioned for SMS messaging."
},
"mms_enabled": {
"type": "boolean",
"description": "Indicates whether the code is provisioned for MMS messaging."
},
"sourcecode_end_date": {
"type": "string",
"description": "Date string indicating when the current code lease expires in ISO-8601 format."
}
}
},
"sourceCodesResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sourceCodeResponse"
}
},
"subscriptionResponse": {
"type": "object",
"properties": {
"person": {
"type": "object",
"description": "Person reference information for the subscription.",
"properties": {
"id": {
"type": "string",
"description": "Vibes-unique person identifier."
},
"url": {
"type": "string",
"description": "Reference URL to the person resource."
}
}
},
"subscription_list": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Vibes unique subscription list identifier."
},
"url": {
"type": "string",
"description": "Reference URL to the subscription list resource."
}
}
},
"opt_in_date": {
"type": "string",
"description": "Date string indicating when the subscription was entered in ISO-8601 format."
},
"opt_out_date": {
"type": "string",
"description": "Date string indicating when the subscription was ended, if relevant, in ISO-8601 format."
},
"opt_out_reason": {
"type": "string",
"description": "The reason why the person was opted-out, if relevant.",
"enum": [
"user_opt_out",
"disconnect",
"list_archived",
"bulk_opt_out",
"failed_at_carrier",
"obsolete_carrier",
"platform_opt_out",
"keyword_opt_out",
"api_opt_out",
"button_opt_out"
]
},
"url": {
"type": "string",
"description": "A reference URL to the existing object, as a relative URL to the existing domain."
}
}
},
"subscriptionsResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscriptionResponse"
}
},
"subscriptionListResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for this particular subscription list."
},
"name": {
"type": "string",
"description": "The display name for the subscription list."
},
"url": {
"type": "string",
"description": "The REST API URL to the subscription list entity."
},
"subscribers_url": {
"type": "string",
"description": "The REST API URL to the subscribers end point."
},
"acquisition_campaigns_url": {
"type": "string",
"description": "The REST API URL to the acquisition campaigns list endpoint."
}
}
},
"subscriptionListsResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subscriptionListResponse"
}
},
"walletCampaignRequest": {
"example": {
"campaign": {
"name": "Spring Sale",
"description": "20% off all items this spring",
"type": "offer",
"expiration_date": "2026-06-30T23:59:59Z",
"redirect_link": "https://example.com/expired"
}
},
"type": "object",
"required": [
"campaign"
],
"properties": {
"campaign": {
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "Descriptive name of the mobile wallet campaign."
},
"description": {
"type": "string",
"description": "Optional longer description of the campaign."
},
"type": {
"type": "string",
"enum": [
"offer",
"loyalty",
"event_ticket"
],
"description": "The kind of pass this campaign issues. One of `offer` (coupon), `loyalty` (store/loyalty card), or `event_ticket`. Immutable after the campaign is created."
},
"expiration_date": {
"type": "string",
"description": "When the campaign expires, in ISO-8601 format. Required for `offer` and `event_ticket` campaigns; optional for `loyalty`."
},
"redirect_link": {
"type": "string",
"description": "Optional URL that end users are redirected to after the campaign has expired."
},
"ignore_unsecure_params": {
"type": "boolean",
"description": "When `true`, only values from a signed (JWT) payload are trusted when personalizing passes; unsigned query parameters are ignored."
},
"security_configuration": {
"type": "object",
"description": "Optional JWT signing configuration used to verify personalization payloads sent on the SmartLink.",
"properties": {
"public_key": {
"type": "string",
"description": "Public key used to verify the JWT signature."
},
"jwt_algorithm": {
"type": "string",
"enum": [
"RS256",
"HS256"
],
"description": "Algorithm used to verify the JWT signature. Defaults to `RS256` (asymmetric); `HS256` is symmetric."
}
}
}
}
}
}
},
"walletCampaignResponse": {
"type": "object",
"properties": {
"wallet_id": {
"type": "string",
"description": "The `wallet_id` is the SmartLink token for the campaign. Use it to identify the campaign in all other Wallet API calls."
},
"name": {
"type": "string",
"description": "Descriptive name of the mobile wallet campaign."
},
"description": {
"type": "string",
"description": "Optional longer description of the campaign. Returned only when set."
},
"type": {
"type": "string",
"enum": [
"offer",
"loyalty",
"event_ticket"
],
"description": "The kind of pass this campaign issues. One of `offer` (coupon), `loyalty` (store/loyalty card), or `event_ticket`."
},
"smartlink_url": {
"type": "string",
"description": "Public SmartLink URL used to distribute the pass to end users (the \"Add to Wallet\" link)."
},
"url": {
"type": "string",
"description": "REST API reference to this wallet campaign, as a relative URL on the API domain."
},
"redirect_link": {
"type": "string",
"description": "URL that end users are redirected to after the campaign has expired. Returned only when set."
},
"expiration_date": {
"type": "string",
"description": "When the campaign expires, in ISO-8601 format. Returned only when set."
},
"ignore_unsecure_params": {
"type": "boolean",
"description": "When `true`, only values from a signed (JWT) payload are trusted when personalizing passes. Returned only when configured."
},
"security_configuration": {
"type": "object",
"description": "JWT signing configuration used to verify personalization payloads. Returned only when configured.",
"properties": {
"public_key": {
"type": "string",
"description": "Public key used to verify the JWT signature. Redacted in responses."
},
"jwt_algorithm": {
"type": "string",
"enum": [
"RS256",
"HS256"
],
"description": "Algorithm used to verify the JWT signature. `RS256` (asymmetric) is the default; `HS256` is symmetric."
}
}
},
"created_at": {
"type": "string",
"description": "When the campaign was created, in ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "When the campaign was last updated, in ISO-8601 format."
}
}
},
"walletCampaignsResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/walletCampaignResponse"
}
},
"walletItemRequest": {
"type": "object",
"properties": {
"tokens": {
"type": "object",
"description": "List of key/value pairs of item specific data that can be used to personalize the item.",
"additionalProperties": {
"type": "string"
}
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"relevant_text": {
"type": "string"
}
}
}
},
"passbook": {
"type": "object",
"properties": {
"notification": {
"type": "string",
"description": "Optional lock screen notification for iOS devices."
}
}
},
"google_wallet": {
"type": "object",
"properties": {
"messages": {
"type": "object",
"description": "Optional update message for Android devices.",
"properties": {
"header": {
"type": "string"
},
"body": {
"type": "string"
}
}
}
}
}
}
},
"walletItemResponse": {
"type": "object",
"properties": {
"wallet_item_id": {
"type": "string",
"description": "Unique Wallet Item ID that was specified at creation. This can be system generated or customer supplied in the creation URL."
},
"group_code": {
"type": "string",
"description": "Optional string value to indicate groups of related Wallet items. Can be used for targeted messaging."
},
"campaign_ref": {
"type": "object",
"description": "Reference to the wallet campaign this item belongs to.",
"properties": {
"id": {
"type": "string",
"description": "The campaign's `wallet_id` (SmartLink token)."
},
"type": {
"type": "string",
"description": "Wallet campaign type."
},
"url": {
"type": "string",
"description": "Reference URL of the wallet campaign, as a relative URL on the API domain."
}
}
},
"active": {
"type": "boolean",
"description": "TRUE if wallet item currently installed on person\u2019s device."
},
"tokens": {
"type": "object",
"description": "Key/value pairs of item-specific data used to personalize this pass (referenced by personalization tags in the template).",
"additionalProperties": {
"type": "string"
}
},
"locations": {
"type": "array",
"description": "Geofenced locations that trigger a lock-screen reminder for this pass.",
"items": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "Latitude of the location."
},
"longitude": {
"type": "number",
"description": "Longitude of the location."
},
"relevant_text": {
"type": "string",
"description": "Message shown on the device when the user is near the location."
}
}
}
},
"provider": {
"type": "string",
"description": "The wallet platform this item was issued to, for example `passbook` (Apple Wallet) or `google_wallet` (Google Wallet)."
},
"passbook": {
"type": "object",
"description": "Apple Wallet (iOS) specific data for this item. Returned only for Apple Wallet passes.",
"properties": {
"notification": {
"type": "string",
"description": "Lock-screen notification text shown on the user's iOS device."
}
}
},
"google_wallet": {
"type": "object",
"description": "Google Wallet (Android) specific data for this item. Returned only for Google Wallet passes.",
"properties": {
"messages": {
"type": "object",
"description": "Update message shown on the user's Android device.",
"properties": {
"header": {
"type": "string",
"description": "Message header."
},
"body": {
"type": "string",
"description": "Message body."
}
}
}
}
},
"created_at": {
"type": "string",
"description": "When the wallet item was created, in ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "When the wallet item was last updated, in ISO-8601 format."
},
"url": {
"type": "string",
"description": "A reference URL to this wallet item, as a relative URL on the API domain."
}
}
},
"walletItemsResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/walletItemResponse"
}
},
"walletMessageRequest": {
"example": {
"message": {
"header": "Reminder",
"template": "Your Spring Sale offer expires soon!"
},
"filters": [
{
"name": "group_code",
"selector": "=",
"value": "vip"
}
]
},
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "object",
"description": "The message content delivered to each targeted pass.",
"properties": {
"template": {
"type": "string",
"description": "Message body sent to each pass. Supports Liquid personalization tags."
},
"header": {
"type": "string",
"description": "Optional header shown with the message."
},
"message_type": {
"type": "string",
"description": "Optional message type used to categorize the notification."
}
}
},
"filters": {
"type": "array",
"description": "Filters that target the message to specific passes in the campaign. Omit to message all passes.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/first-class-filters"
},
{
"$ref": "#/components/schemas/wallet-filters"
},
{
"$ref": "#/components/schemas/first-class-filters-any"
},
{
"$ref": "#/components/schemas/wallet-filters-any"
}
]
}
}
}
},
"walletMessageResponse": {
"type": "object",
"properties": {
"wallet_message_id": {
"type": "string",
"description": "Unique system-generated identifier for each message created."
},
"message": {
"type": "object",
"description": "The message content that was delivered.",
"properties": {
"template": {
"type": "string",
"description": "Message body sent to each pass."
},
"header": {
"type": "string",
"description": "Header shown with the message."
}
}
},
"campaign_ref": {
"type": "object",
"description": "Reference to the wallet campaign this message belongs to.",
"properties": {
"id": {
"type": "string",
"description": "The campaign's `wallet_id` (SmartLink token)."
},
"type": {
"type": "string",
"description": "Wallet campaign type."
},
"url": {
"type": "string",
"description": "Reference URL of the wallet campaign, as a relative URL on the API domain."
}
}
},
"filters": {
"type": "array",
"description": "Filters that were applied to target the message.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Field the filter is applied to, for example `group_code`, `provider`, or `expiration_date`."
},
"selector": {
"type": "string",
"description": "Comparison used by the filter, for example `=`, `starts_with`, or `between`."
},
"value": {
"type": "string",
"description": "Value compared against the field."
}
}
}
},
"created_at": {
"type": "string",
"description": "When the message was created, in ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "When the message was last updated, in ISO-8601 format."
},
"url": {
"type": "string",
"description": "A reference URL to this message, as a relative URL on the API domain."
}
}
},
"walletMessagesResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/walletMessageResponse"
}
},
"locationSelectorBody": {
"type": "object",
"description": "Branding for the \"Add to Wallet\" landing page a customer sees before the pass is generated \u2014 the page where they pick their store location (drawn from the campaign's locations) and tap to install.",
"properties": {
"image": {
"type": "object",
"description": "Image shown on the landing page (max 2 MB).",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the image."
}
}
},
"header": {
"type": "object",
"description": "Landing page heading.",
"properties": {
"title": {
"type": "string",
"description": "Page title."
},
"tagline": {
"type": "string",
"description": "Page subtitle."
}
}
},
"colors": {
"type": "object",
"description": "Landing page colors as hex values.",
"properties": {
"background": {
"type": "string",
"description": "Page background color."
},
"foreground": {
"type": "string",
"description": "Text color."
},
"label": {
"type": "string",
"description": "Label color."
}
}
},
"fontsize": {
"type": "integer",
"description": "Font size used for the page text."
},
"include_zipcode": {
"type": "boolean",
"description": "When set to `true`, you may bypass the location selector by passing the end user\u2019s zip code as a URL param (ex. `?zipcode=99999`). If no zip code is passed, the user will still see the location selector."
},
"add_to_wallet_language": {
"type": "string",
"enum": [
"en-US",
"es-ES",
"es-419",
"fr-FR"
],
"description": "Locale of the \"Add to Wallet\" button. One of `en-US` (English), `es-ES` (Spanish - Spain), `es-419` (Spanish - Latin America), or `fr-FR` (French)."
}
}
},
"locationSelectorRequest": {
"example": {
"location_selector": {
"header": {
"title": "Add your pass",
"tagline": "Tap below to save it to your wallet"
},
"colors": {
"background": "#ffffff",
"foreground": "#000000",
"label": "#888888"
},
"include_zipcode": true,
"add_to_wallet_language": "en-US"
}
},
"type": "object",
"required": [
"location_selector"
],
"properties": {
"location_selector": {
"allOf": [
{
"$ref": "#/components/schemas/locationSelectorBody"
}
]
}
}
},
"locationSelectorResponse": {
"allOf": [
{
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Public token of the location selector."
},
"url": {
"type": "string",
"description": "Public landing page URL."
},
"created_at": {
"type": "string",
"description": "When the location selector was created, in ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "When the location selector was last updated, in ISO-8601 format."
}
}
},
{
"$ref": "#/components/schemas/locationSelectorBody"
}
]
},
"walletLocation": {
"type": "object",
"description": "A store location attached to a wallet campaign.",
"properties": {
"location_id": {
"type": "string",
"description": "Your own identifier for the store (for example a store number)."
},
"name": {
"type": "string",
"description": "Store or location name."
},
"address": {
"type": "string",
"description": "Street address."
},
"address_2": {
"type": "string",
"description": "Optional second address line (suite, unit, etc.)."
},
"city": {
"type": "string",
"description": "City."
},
"state": {
"type": "string",
"description": "State or province."
},
"zip": {
"type": "string",
"description": "Zip or postal code."
},
"phone_number": {
"type": "string",
"description": "Store contact phone number."
},
"store_hours": {
"type": "string",
"description": "Store operating hours."
},
"latitude": {
"type": "string",
"description": "Latitude of the location."
},
"longitude": {
"type": "string",
"description": "Longitude of the location."
},
"notification_message": {
"type": "string",
"description": "Lock-screen message shown to pass holders when they are near this location."
}
}
},
"walletLocationResponse": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the store location."
}
}
},
{
"$ref": "#/components/schemas/walletLocation"
}
]
},
"walletLocationsResponse": {
"type": "array",
"items": {
"$ref": "#/components/schemas/walletLocationResponse"
}
},
"walletLocationsBulkRequest": {
"example": {
"locations": [
{
"location_id": "store-001",
"name": "Downtown",
"address": "123 Main St",
"city": "Chicago",
"state": "IL",
"zip": "60601",
"latitude": "41.8781",
"longitude": "-87.6298",
"notification_message": "Stop by the downtown store!"
}
]
},
"type": "object",
"required": [
"locations"
],
"properties": {
"locations": {
"type": "array",
"description": "Store locations to add (up to 1000 per request).",
"items": {
"$ref": "#/components/schemas/walletLocation"
}
}
}
},
"googleWalletTemplateBody": {
"type": "object",
"description": "Design and content of a Google Wallet (Android) pass. Google models three pass kinds \u2014 Offer, Loyalty, and Event Ticket \u2014 that share a common frame; field semantics follow Google Wallet generic passes (https://developers.google.com/wallet/generic). Many text fields accept Liquid personalization tags that are replaced per recipient. Fields noted as \"loyalty only\" or \"event ticket only\" apply only to campaigns of that type.",
"properties": {
"title": {
"type": "string",
"description": "The pass headline."
},
"issuer": {
"type": "string",
"description": "Organization that issues the pass."
},
"provider": {
"type": "string",
"description": "Merchant shown on the card. Required for offer passes."
},
"description": {
"type": "string",
"description": "Free-text offer description shown on the pass. Offer passes only."
},
"background_color": {
"type": "string",
"description": "Color that fills the card, as a hex value (for example `#1a73e8`)."
},
"nfc_message": {
"type": "string",
"description": "Payload delivered when the pass is tapped on an NFC terminal (smart tap)."
},
"enable_expiration_notification": {
"type": "boolean",
"description": "When `true`, sends the pass holder a push notification before the offer expires. Offer passes only."
},
"logo": {
"type": "object",
"description": "Small circular logo shown on the pass.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the logo image."
}
}
},
"hero_image": {
"type": "object",
"description": "Large featured image shown on the pass.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the hero image."
}
}
},
"strip_image": {
"type": "object",
"description": "Wide banner image shown on the pass.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the strip image."
}
}
},
"strip_images": {
"type": "array",
"description": "Per-recipient alternates of the `strip_image` banner. They share the single strip slot \u2014 only one is shown per pass, chosen at issue time by matching the recipient's `IMAGE_CODE` personalization token against `image_code`. If none matches, the default `strip_image` is shown. Each `image_code` must be unique within the array.",
"items": {
"type": "object",
"properties": {
"image_code": {
"type": "string",
"description": "Unique code used to select this image for a recipient."
},
"url": {
"type": "string",
"description": "Public URL of the strip image."
}
}
}
},
"barcode": {
"type": "object",
"description": "The scannable code shown on the pass.",
"properties": {
"type": {
"type": "string",
"description": "Barcode format \u2014 one of `QR_CODE`, `PDF_417`, `AZTEC`, `CODE_128`, `TEXT_ONLY`, or `None` (lowercase variants `qrCode`, `pdf417`, `aztec`, `code128`, `textOnly` are also accepted)."
},
"label": {
"type": "string",
"description": "Caption shown beneath the barcode."
},
"value": {
"type": "string",
"description": "Barcode content (ASCII only). Required unless `type` is `None`."
},
"alternate_text": {
"type": "string",
"description": "Human-readable text shown alongside the barcode."
}
}
},
"loyalty_points": {
"type": "object",
"description": "Points balance shown on the pass. Loyalty passes only.",
"properties": {
"label": {
"type": "string",
"description": "Caption for the points balance."
},
"balance": {
"type": "string",
"description": "Points balance value. Required when a label is present."
}
}
},
"secondary_loyalty_points": {
"type": "object",
"description": "Secondary points balance shown on the pass. Loyalty passes only.",
"properties": {
"label": {
"type": "string",
"description": "Caption for the secondary points balance."
},
"balance": {
"type": "string",
"description": "Secondary points balance value. Required when a label is present."
}
}
},
"account": {
"type": "object",
"description": "Account details shown on the pass. Loyalty passes only.",
"properties": {
"name": {
"type": "string",
"description": "Account holder name."
},
"name_label": {
"type": "string",
"description": "Caption for the account holder name."
},
"id": {
"type": "string",
"description": "Account identifier."
},
"id_label": {
"type": "string",
"description": "Caption for the account identifier."
}
}
},
"rewards_tier": {
"type": "object",
"description": "Rewards tier shown on the pass. Loyalty passes only.",
"properties": {
"label": {
"type": "string",
"description": "Caption for the rewards tier."
},
"name": {
"type": "string",
"description": "Rewards tier name."
}
}
},
"text_area": {
"type": "array",
"description": "Free-text modules shown on the pass.",
"items": {
"type": "object",
"properties": {
"header": {
"type": "string",
"description": "Module heading. Supply both header and body, or leave both blank."
},
"body": {
"type": "string",
"description": "Module body text."
}
}
}
},
"subinfo": {
"type": "array",
"description": "Info-module rows (heading/body pairs) shown on the pass.",
"items": {
"type": "object",
"properties": {
"header": {
"type": "string",
"description": "Row heading. Supply both header and body, or leave both blank."
},
"body": {
"type": "string",
"description": "Row body text."
}
}
}
},
"messages": {
"type": "array",
"description": "Push-style announcements shown on the pass. Loyalty and event ticket passes only.",
"items": {
"type": "object",
"properties": {
"header": {
"type": "string",
"description": "Message heading."
},
"body": {
"type": "string",
"description": "Message body text."
}
}
}
},
"links": {
"type": "array",
"description": "Links module shown on the pass.",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Link label. Required when a URI is present."
},
"uri": {
"type": "string",
"description": "Link target URL."
}
}
}
},
"help": {
"type": "object",
"description": "Help link shown on the pass. Event ticket passes only.",
"properties": {
"uri": {
"type": "string",
"description": "Help link target URL."
},
"description": {
"type": "string",
"description": "Help link label."
}
}
},
"homepage": {
"type": "object",
"description": "Homepage link shown on the pass. Event ticket passes only.",
"properties": {
"uri": {
"type": "string",
"description": "Homepage URL."
},
"description": {
"type": "string",
"description": "Homepage link label."
}
}
},
"trackers": {
"type": "array",
"description": "Tracking-pixel definitions. Each renders a 1x1 image beacon that fires on a pass lifecycle event for analytics.",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Lifecycle event that fires the tracker. One of `view`, `add`, or `remove`."
},
"tag": {
"type": "string",
"description": "Beacon URL requested when the action occurs."
}
}
}
},
"event_id": {
"type": "string",
"description": "Identifier that groups tickets for the same event (max 64 characters). Event ticket passes only."
},
"ticket_holder_name": {
"type": "string",
"description": "Name of the ticket holder. Event ticket passes only."
},
"ticket_number": {
"type": "string",
"description": "Ticket number. Event ticket passes only."
},
"ticket_type": {
"type": "string",
"description": "Ticket type. Event ticket passes only."
},
"venue": {
"type": "object",
"description": "Event venue shown on the pass. Event ticket passes only.",
"properties": {
"name": {
"type": "string",
"description": "Venue name. Required when a venue is present."
},
"address": {
"type": "string",
"description": "Venue address. Required when a venue is present."
}
}
},
"event_info": {
"type": "object",
"description": "Event timing shown on the pass. Event ticket passes only.",
"properties": {
"doors_open_time": {
"type": "string",
"description": "When doors open."
},
"doors_open_label": {
"type": "string",
"description": "Caption for the doors-open time."
},
"start_time": {
"type": "string",
"description": "Event start time."
},
"end_time": {
"type": "string",
"description": "Event end time."
}
}
},
"seat_info": {
"type": "object",
"description": "Seat assignment shown on the pass. Event ticket passes only. Supply each value together with its matching label.",
"properties": {
"section": {
"type": "string",
"description": "Seat section."
},
"section_label": {
"type": "string",
"description": "Caption for the section."
},
"row": {
"type": "string",
"description": "Seat row."
},
"row_label": {
"type": "string",
"description": "Caption for the row."
},
"seat": {
"type": "string",
"description": "Seat number."
},
"seat_label": {
"type": "string",
"description": "Caption for the seat."
},
"gate": {
"type": "string",
"description": "Entry gate."
},
"gate_label": {
"type": "string",
"description": "Caption for the gate."
}
}
},
"reservation_info": {
"type": "object",
"description": "Reservation confirmation shown on the pass. Event ticket passes only.",
"properties": {
"confirmation_code": {
"type": "string",
"description": "Reservation confirmation code."
},
"confirmation_code_label": {
"type": "string",
"description": "Caption for the confirmation code."
}
}
},
"grouping_info": {
"type": "object",
"description": "Controls how related passes are grouped together on the device. Event ticket passes only.",
"properties": {
"sort_index": {
"type": "integer",
"description": "Position of this pass within its group."
}
}
}
}
},
"androidTemplateRequest": {
"example": {
"wallet_template": {
"title": "Spring Sale",
"issuer": "Example Co",
"provider": "Example Store",
"background_color": "#1a73e8",
"logo": {
"url": "https://cdn.example.com/logo.png"
},
"barcode": {
"type": "QR_CODE",
"value": "{{ token }}",
"alternate_text": "12345"
}
}
},
"type": "object",
"required": [
"wallet_template"
],
"properties": {
"wallet_template": {
"required": [
"title",
"issuer",
"logo",
"barcode"
],
"allOf": [
{
"$ref": "#/components/schemas/googleWalletTemplateBody"
}
]
}
}
},
"androidTemplateResponse": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the Google Wallet template."
},
"active": {
"type": "boolean",
"description": "Whether the template is active."
},
"created_at": {
"type": "string",
"description": "When the template was created, in ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "When the template was last updated, in ISO-8601 format."
}
}
},
{
"$ref": "#/components/schemas/googleWalletTemplateBody"
}
]
},
"appleWalletTemplateBody": {
"type": "object",
"description": "Design and content of an Apple Wallet (iOS) pass \u2014 a card with a front and a back whose fields map to fixed regions on the card. Field semantics follow Apple Wallet Passes (https://developer.apple.com/documentation/WalletPasses). Many text fields accept Liquid personalization tags that are replaced per recipient.",
"properties": {
"organization_name": {
"type": "string",
"description": "Organization name shown next to the lock-screen notification. Falls back to the signing certificate's value if not set."
},
"pass_description": {
"type": "string",
"description": "Short accessibility (VoiceOver) description of the pass. Required by Apple Wallet; defaults to the card type if left blank."
},
"logo_text": {
"type": "string",
"description": "Text rendered beside the logo at the top of the pass."
},
"nfc_message": {
"type": "string",
"description": "Payload delivered when the pass is tapped on an NFC terminal (tap-to-interact)."
},
"app_id": {
"type": "string",
"description": "Optional iOS App Store identifier (for example `id123456` or `123456`). When set, the pass links to the associated app and surfaces an open-app affordance."
},
"thank_you_url": {
"type": "string",
"description": "Optional URL opened after the pass is installed."
},
"thank_you_message": {
"type": "string",
"description": "Optional message shown after the pass is installed. Ignored when `thank_you_url` is set."
},
"sharing_prohibited": {
"type": "boolean",
"description": "When `true`, hides the pass's share button."
},
"colors": {
"type": "object",
"description": "Pass colors as hex values, for example `#ff0000`. All three are required.",
"properties": {
"background": {
"type": "string",
"description": "Card fill color."
},
"foreground": {
"type": "string",
"description": "Color of the field values."
},
"label": {
"type": "string",
"description": "Color of the field labels."
}
}
},
"barcode": {
"type": "object",
"description": "The scannable code shown on the pass.",
"properties": {
"type": {
"type": "string",
"description": "Barcode format \u2014 one of `PKBarcodeFormatQR`, `PKBarcodeFormatPDF417`, `PKBarcodeFormatAztec`, or `PKBarcodeFormatCode128` (Apple's format identifiers)."
},
"code": {
"type": "string",
"description": "Barcode content (ASCII only)."
},
"description": {
"type": "string",
"description": "Human-readable text shown alongside the barcode."
}
}
},
"images": {
"type": "object",
"description": "Images shown on the pass, keyed by role. Each role occupies a fixed slot on the card. `logo` and `icon` are required; the others are optional.",
"properties": {
"logo": {
"type": "object",
"description": "Brand logo, shown at the top-left of the pass. Required.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the logo image."
}
}
},
"icon": {
"type": "object",
"description": "Small icon used on the lock screen and in notifications. Required.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the icon image."
}
}
},
"strip": {
"type": "object",
"description": "Wide banner image shown behind the primary fields.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the strip image."
}
}
},
"preview_strip": {
"type": "object",
"description": "Strip image shown in the \"Add to Wallet\" preview before the pass is installed.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the preview strip image."
}
}
},
"background_image": {
"type": "object",
"description": "Full-card background image. Event ticket passes only.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the background image."
}
}
},
"thumbnail": {
"type": "object",
"description": "Small square image shown to the right of the primary fields. Event ticket passes only.",
"properties": {
"url": {
"type": "string",
"description": "Public URL of the thumbnail image."
}
}
}
}
},
"strip_images": {
"type": "array",
"description": "Per-recipient alternates of the strip banner. They share the single strip slot \u2014 only one is shown per pass, chosen at issue time by matching the recipient's `IMAGE_CODE` personalization token against `image_code`. If none matches, the default `strip` image is shown. Each `image_code` must be unique within the array.",
"items": {
"type": "object",
"properties": {
"image_code": {
"type": "string",
"description": "Unique code used to select this image for a recipient."
},
"url": {
"type": "string",
"description": "Public URL of the strip image."
}
}
}
},
"fields": {
"type": "object",
"description": "The pass's text content, grouped into Apple Wallet's five fixed regions. Each region holds an array of label/value entries.",
"properties": {
"header": {
"type": "array",
"description": "Top edge of the pass, beside the logo. Stays visible when the pass is stacked/collapsed in Wallet \u2014 best for the one value seen at a glance (balance, gate, points).",
"items": {
"$ref": "#/components/schemas/passbookField"
}
},
"primary": {
"type": "array",
"description": "The largest, most prominent text on the front, over the strip image \u2014 the headline value (the offer, the seat, the reward).",
"items": {
"$ref": "#/components/schemas/passbookField"
}
},
"secondary": {
"type": "array",
"description": "A smaller row beneath the primary fields \u2014 supporting details such as expiration or cardholder name.",
"items": {
"$ref": "#/components/schemas/passbookField"
}
},
"auxiliary": {
"type": "array",
"description": "A further, smallest row beneath the secondary fields \u2014 extra details such as member level or location.",
"items": {
"$ref": "#/components/schemas/passbookField"
}
},
"back": {
"type": "array",
"description": "The reverse side, reached by tapping the info button on the pass \u2014 long-form content such as terms, contact info, and fine print.",
"items": {
"$ref": "#/components/schemas/passbookField"
}
}
}
},
"trackers": {
"type": "array",
"description": "Tracking-pixel definitions. Each renders a 1x1 image beacon that fires on a pass lifecycle event for analytics.",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Lifecycle event that fires the tracker. One of `view`, `add`, or `remove`."
},
"tag": {
"type": "string",
"description": "Beacon URL requested when the action occurs."
}
}
}
},
"personalization_options": {
"type": "object",
"description": "Configures the Apple Wallet sign-up form a user fills in when adding the pass, to enrol them in a rewards program. Applies to loyalty (store-card) passes only. Returned only when configured; the `api` username and password are masked in responses.",
"properties": {
"description": {
"type": "string",
"description": "Text shown on the enrollment screen."
},
"terms_and_conditions": {
"type": "string",
"description": "Terms the user must accept to enroll."
},
"required_personalization_fields": {
"type": "array",
"description": "Personal details collected during enrollment, for example `given_name`, `family_name`, `full_name`, `email_address`, `phone_number`, `postal_code`.",
"items": {
"type": "string"
}
},
"api": {
"type": "object",
"description": "Loyalty backend the enrollment form is submitted to.",
"properties": {
"base_url": {
"type": "string",
"description": "Base URL of the loyalty backend."
},
"username": {
"type": "string",
"description": "Username for the loyalty backend (HTTP Basic). Masked in responses."
},
"password": {
"type": "string",
"description": "Password for the loyalty backend (HTTP Basic). Masked in responses."
}
}
}
}
}
}
},
"passbookField": {
"type": "object",
"description": "A single label/value entry within an Apple Wallet pass field region.",
"properties": {
"label": {
"type": "string",
"description": "Small caption shown above the value (rendered in the label color)."
},
"value": {
"type": "string",
"description": "Field content (rendered in the foreground color)."
},
"change_message": {
"type": "string",
"description": "Notification text shown when this field changes on an installed pass. Must contain the `%@` placeholder for the new value."
}
}
},
"iosTemplateRequest": {
"example": {
"passbook_template": {
"organization_name": "Example Co",
"pass_description": "Spring Sale offer",
"logo_text": "Spring Sale",
"colors": {
"background": "#ff0000",
"foreground": "#ffffff",
"label": "#cccccc"
},
"barcode": {
"type": "PKBarcodeFormatQR",
"code": "{{ token }}",
"description": "Scan at checkout"
},
"images": {
"logo": {
"url": "https://cdn.example.com/logo.png"
},
"icon": {
"url": "https://cdn.example.com/icon.png"
}
},
"fields": {
"primary": [
{
"label": "Discount",
"value": "20% off"
}
]
}
}
},
"type": "object",
"required": [
"passbook_template"
],
"properties": {
"passbook_template": {
"required": [
"pass_description",
"colors",
"images"
],
"allOf": [
{
"$ref": "#/components/schemas/appleWalletTemplateBody"
}
]
}
}
},
"iosTemplateResponse": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the Apple Wallet template."
},
"active": {
"type": "boolean",
"description": "Whether the template is active."
},
"created_at": {
"type": "string",
"description": "When the template was created, in ISO-8601 format."
},
"updated_at": {
"type": "string",
"description": "When the template was last updated, in ISO-8601 format."
}
}
},
{
"$ref": "#/components/schemas/appleWalletTemplateBody"
}
]
},
"mmsurl": {
"type": "object",
"title": "Media URL",
"properties": {
"media_url": {
"type": "string",
"description": "A URL link to the media to be included in the MMS. Do not use if you are using asset_id."
},
"description": {
"type": "string",
"description": "An optional description of the media. Use only if you are using media_URL."
}
}
},
"mmstext": {
"type": "object",
"title": "Text",
"properties": {
"body": {
"type": "string",
"description": "The body text included in the MMS send."
},
"mime_type": {
"type": "string",
"description": "Must be text/plain for this object.",
"enum": [
"text/plain"
]
}
}
},
"filters-number": {
"type": "number",
"title": "Choose if filtering by subscription list."
},
"filters-string": {
"type": "string",
"title": "Choose for all other filters."
},
"wallet-filters": {
"type": "object",
"title": "Filter by another field.",
"properties": {
"name": {
"type": "string",
"enum": [
"group_code",
"provider",
"expiration_date"
]
},
"selector": {
"type": "string",
"enum": [
"starts_with",
"between",
"=",
"<",
"<=",
">",
">=",
"before",
"after",
"between",
"on"
]
},
"value": {
"type": "string"
}
}
},
"wallet-filters-any": {
"type": "object",
"title": "Filter by another field using selector \"any\".",
"properties": {
"name": {
"type": "string",
"enum": [
"group_code",
"provider",
"expiration_date"
]
},
"selector": {
"type": "string",
"enum": [
"any"
]
},
"value": {
"type": "array",
"description": "Add each value in its own string",
"items": {
"type": "string"
}
}
}
},
"first-class-filters": {
"type": "object",
"title": "Filter by first-class field.",
"description": "Learn more about first-class fields.",
"properties": {
"name": {
"type": "string",
"enum": [
"first_class_field"
]
},
"field_name": {
"type": "string",
"enum": [
"email_address",
"external_email_id",
"first_name",
"last_name",
"code",
"expiration_date",
"account_number",
"balance",
"tier",
"offer_value",
"loyalty_tier",
"loyalty_balance",
"strip_image_code"
]
},
"selector": {
"type": "string",
"enum": [
"starts_with",
"between",
"=",
"<",
"<=",
">",
">=",
"before",
"after",
"between",
"on"
]
},
"value": {
"type": "string"
}
}
},
"first-class-filters-any": {
"type": "object",
"title": "Filter by first-class field using selector \"any\".",
"description": "Learn more about first-class fields.",
"properties": {
"name": {
"type": "string",
"enum": [
"first_class_field"
]
},
"field-name": {
"type": "string",
"enum": [
"email_address",
"external_email_id",
"first_name",
"last_name",
"code",
"expiration_date",
"account_number",
"balance",
"tier",
"offer_value",
"loyalty_tier",
"loyalty_balance",
"strip_image_code"
]
},
"selector": {
"type": "string",
"enum": [
"any"
]
},
"value": {
"type": "array",
"description": "Add each value in its own string",
"items": {
"type": "string"
}
}
}
},
"testcallbackRequest-Ack": {
"type": "object",
"title": "Acquisition Callbacks",
"properties": {
"callback_type": {
"type": "string",
"description": "The type of callback you'd like to receive the test callback for.",
"enum": [
"ack_participant_added",
"ack_participant_changed",
"company_participant_added",
"company_participant_changed"
]
},
"participant": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "person_id of person who is being added or removed from this acquisition campaign."
},
"mobile_phone": {
"type": "object",
"properties": {
"mdn": {
"type": "string",
"description": "Mobile phone number for person who is being added or removed from this acquisition campaign."
}
}
},
"acquisition_campaign": {
"type": "object",
"properties": {
"api_key": {
"type": "string",
"description": "This is the acquisition_id of the campaign a person is being added to. If using ack_participant_added or ack_participant_changed, api_key is required."
},
"description": {
"type": "string",
"description": "The value here will be returned in the callback. This is optional."
},
"keyword": {
"type": "string",
"description": "The value here will be returned in the callback. This is optional."
}
}
},
"subscription_list": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The subscription_list_id of the list the participant is being added to."
}
}
}
}
}
},
"required": [
"callback_type"
]
},
"testcallbackRequest-Event": {
"type": "object",
"title": "Event-Triggered Callbacks",
"properties": {
"callback_type": {
"type": "string",
"description": "The type of callback you'd like to receive the test callback for.",
"enum": [
"event_processed"
]
},
"event_processed": {
"type": "object",
"properties": {
"event_id": {
"type": "string",
"description": "event_id for your test event."
},
"event_data": {
"type": "object",
"description": "Enter any event_data that will be passed along in your test callback."
}
}
}
},
"required": [
"callback_type"
]
},
"testcallbackRequest-Person": {
"type": "object",
"title": "Person Callbacks",
"properties": {
"callback_type": {
"type": "string",
"description": "The type of callback you'd like to receive the test callback for.",
"enum": [
"person_added",
"person_updated"
]
},
"person": {
"type": "object",
"properties": {
"person_id": {
"type": "string",
"description": "person_id for person being added or updated."
},
"external_person_id": {
"type": "string",
"description": "external_person_id for person being added or updated."
},
"mobile": {
"type": "object",
"properties": {
"mdn": {
"type": "string",
"description": "Mobile phone number of person being added or updated."
},
"carrier_code": {
"type": "string",
"description": "Carrier code for person's mobile phone carrier."
}
}
},
"custom_fields": {
"type": "object",
"description": "Any custom fields being added or updated for the person."
}
}
}
},
"required": [
"callback_type"
]
},
"testcallbackRequest-Push": {
"type": "object",
"title": "Push Device Callbacks",
"properties": {
"callback_type": {
"type": "string",
"description": "The type of callback you'd like to receive the test callback for.",
"enum": [
"device_added",
"device_removed",
"device_updated"
]
},
"person": {
"type": "object",
"properties": {
"person_id": {
"type": "string",
"description": "person_id for the person associated with the push device being added/updated/removed."
},
"external_person_id": {
"type": "string",
"description": "external_person_id for the person associated with the push device being added/updated/removed."
}
}
},
"push_device": {
"type": "object",
"properties": {
"app_id": {
"type": "string",
"description": "Your app id."
},
"vibes_device_id": {
"type": "string"
},
"push_token": {
"type": "string"
},
"device_os": {
"type": "string"
}
}
}
},
"required": [
"callback_type"
]
},
"testcallbackRequest-Sub": {
"type": "object",
"title": "Subscription Callbacks",
"properties": {
"callback_type": {
"type": "string",
"description": "The type of callback you'd like to receive the test callback for.",
"enum": [
"subscription_added",
"subscription_removed"
]
},
"subscription": {
"type": "object",
"properties": {
"person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "person_id for the subscriber."
}
}
},
"subscription_list": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "subscription_list_id for list for which a subscriber is being added or removed."
}
},
"required": [
"id"
]
}
},
"required": [
"subscription_list"
]
}
},
"required": [
"callback_type"
]
},
"testcallbackRequest-SubList": {
"type": "object",
"title": "Subscription List Callbacks",
"properties": {
"callback_type": {
"type": "string",
"description": "The type of callback you'd like to receive the test callback for.",
"enum": [
"subscription_list_added",
"subscription_list_updated"
]
},
"subscription_list": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "subscription_list_id for the list that is being added or updated."
},
"name": {
"type": "string",
"description": "Name of subscription list being added or updated."
}
}
}
},
"required": [
"callback_type"
]
},
"testcallbackRequest-Wallet": {
"type": "object",
"title": "Wallet Callbacks",
"properties": {
"callback_type": {
"type": "string",
"description": "The type of callback you'd like to receive the test callback for.",
"enum": [
"wallet_item_install",
"wallet_item_remove"
]
}
},
"required": [
"callback_type"
]
}
}
}
}