{"openapi":"3.1.0","info":{"title":"menta tech API Documentation","version":"v.1.0","description":"API for managing events, tickets, and marketplace operations. This documentation covers integrating with the menta platform for event creation, ticket management, secondary market operations, and user authentication.<br><br>Base URL: https://api.mentatech.io - Authentication requires a valid API Key in the Authorization header.<br><br>The menta platform uses a relational data model where endpoints build upon previously created data. For example, ticket creation requires an existing event with defined price types and zones.<br><br>We recommend following this documentation sequentially as it follows the logical integration flow.<br><br>While our API has minimal required fields, providing optional fields unlocks more powerful features - from enhanced marketplace capabilities to advanced ticket management. For example, detailed seat information enables precise seat selection, while comprehensive event metadata improves the user experience."},"tags":[{"name":"Events","description":"Operations related to creating, updating, and managing events and their associated shows. This is the first step of the integration. "},{"name":"Tickets","description":"Operations for ticket creation, management, validation, and admission control."},{"name":"Marketplace","description":"Operations for the secondary market, including listing tickets for sale and purchasing tickets."},{"name":"Build Your Own Buyingflow","description":"Streamlined checkout experience for marketplace purchases"},{"name":"Auth","description":"Authentication operations for secure user access and verification."},{"name":"Smart Access Layer","description":"Operations for retrieving smart access layer components that provide dynamic UI elements (buttons, banners, modals, lists, maps) for buy/sell functionality."},{"name":"Market Data","description":"Operations for managing event market data including inventory levels and ticket leads for identifying potential buyers and sellers in the secondary market."}],"paths":{"/v1/events":{"post":{"tags":["Events"],"summary":"Create an Event","description":"Creates a new event in the system with all associated metadata. Events can include multiple shows, ticket options, and configuration settings. This endpoint provides a standardized way to integrate your ticketing system with menta and serves as the foundation for all ticket operations.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The main title of the event that will be displayed to users throughout the platform."},"description":{"type":"string","example":"Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.","description":"A detailed description of the event, including relevant information for potential attendees. This supports rich text formatting."},"externalReferenceId":{"type":"string","example":"123","description":"The unique identifier of the event in your ticketing system. This ID is used for all future references to this event."},"shows":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The title of the show, which may differ from the event title if there are multiple performances."},"date":{"type":"string","example":"2024-11-06","description":"The exact date and time when the show starts, in ISO 8601 format. This should include timezone information."},"showId":{"type":"string","example":"123","description":"The unique identifier of the show in your ticketing system. This is used to correlate tickets with specific performances."},"primarySalesUrl":{"type":"string","minLength":1,"example":"https://www.themasteroftheticket.com/event/1234567890/show/179","description":"The direct URL to purchase tickets for this specific show through the primary sales channel. This can be used for redirects from the marketplace."},"status":{"type":"string","enum":["LIVE","CANCELLED"],"example":"LIVE","description":"The current status of the show. A cancelled show will not be available for ticket sales or transfers."},"ticketOptions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"ticketId":{"type":"string"},"description":{"type":"string"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"stock":{"type":"number"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"area":{"type":"string"}},"required":["title","ticketId","description","currency"],"description":"The ticket options available for purchase for the show. Each ticket option represents a distinct ticket type with its own price point, description, and availability.","example":{"title":"General Admission","ticketId":"123","description":"General admission ticket","price":100,"currency":"USD","stock":700,"webVisibility":true,"webSoldOut":false,"area":"VIP"}}},"priceTypes":{"type":"array","items":{"type":"object","properties":{"_id":{},"priceTypeId":{"type":"string","minLength":1},"title":{"type":"string"},"description":{"type":"string"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"stock":{"type":"number"},"invisible":{"type":"boolean","default":false},"inventory":{"type":"object","properties":{"releasedTickets":{"type":"number","minimum":0},"reservedSpace":{"type":"number","minimum":0},"soldOut":{"type":"boolean"},"soldPercentage":{"type":"number","minimum":0,"maximum":100}}}},"required":["priceTypeId"],"description":"The price types available for purchase for the show. Price types represent different pricing tiers or promotional pricing (e.g., Early Bird, VIP, etc.) that can be applied to ticket options.","example":{"title":"Early Birds","description":"Early birds get in for a lower price!","priceTypeId":"123"}}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"kind":{"type":"string","enum":["main","secondary","nft"],"default":"main"},"originalUrl":{"type":"string"}},"required":["url"]},"description":"The images associated with this show. These are used in various user interfaces to represent the show visually.","example":[{"url":"https://www.themasteroftheticket.com/images/shows/179/1.jpg","kind":"main"}]},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Additional configuration options specific to this show, which may override event-level settings."},"showRescheduled":{"type":"boolean","default":false,"example":true,"description":"Indicates whether the show has been rescheduled from its original date. This affects how the show is presented to users and may trigger notifications."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"description":"The location where the show will take place. This overrides the event-level location if specified.","example":{"address":"123 Main St","city":"Atlanta","state":"GA","raw":"Put here the full address instead of the address, city, state fields, CA","map":{"thumbnail":"https://example.com/thumbnail.jpg","googleMapsUrl":"https://example.com/google-maps-url"},"postalCode":"12345","country":"USA","venueName":"Example Venue"}},"resaleEnabled":{"type":"boolean","default":true,"example":true,"description":"Controls whether tickets for this show can be resold on the secondary marketplace. Set to false to disable resale completely."}},"required":["title","date","showId","ticketOptions","images","configuration"],"description":"Detailed information about the shows or performances that make up this event. An event can have multiple shows, each with its own date, time, and ticket options."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"description":"The primary location where the event will take place. If shows occur in different locations, specify the location at the show level instead."},"producers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"producerId":{"type":"string"}},"required":["producerId"]},"description":"Information about the organizations or individuals producing the event. This is used for communication, reporting, and access control."},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Global configuration settings that apply to all shows in this event. These can be overridden by show-specific configurations."},"seating":{"type":"object","properties":{"image":{"type":"string"},"svgCode":{"type":"string"}},"description":"Seating chart configuration for venues with assigned seating. This includes section layouts, seat numbering, and other seating-related settings."}},"required":["title","description","externalReferenceId","shows","location","configuration"]}}}},"responses":{"200":{"description":"Event successfully created with all provided details","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The main title of the event that will be displayed to users throughout the platform."},"description":{"type":"string","example":"Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.","description":"A detailed description of the event, including relevant information for potential attendees. This supports rich text formatting."},"externalReferenceId":{"type":"string","example":"123","description":"The unique identifier of the event in your ticketing system. This ID is used for all future references to this event."},"shows":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The title of the show, which may differ from the event title if there are multiple performances."},"date":{"type":"string","example":"2024-11-06","description":"The exact date and time when the show starts, in ISO 8601 format. This should include timezone information."},"showId":{"type":"string","example":"123","description":"The unique identifier of the show in your ticketing system. This is used to correlate tickets with specific performances."},"primarySalesUrl":{"type":"string","minLength":1,"example":"https://www.themasteroftheticket.com/event/1234567890/show/179","description":"The direct URL to purchase tickets for this specific show through the primary sales channel. This can be used for redirects from the marketplace."},"status":{"type":"string","enum":["LIVE","CANCELLED"],"example":"LIVE","description":"The current status of the show. A cancelled show will not be available for ticket sales or transfers."},"ticketOptions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"ticketId":{"type":"string"},"description":{"type":"string"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"stock":{"type":"number"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"area":{"type":"string"}},"required":["title","ticketId","description","currency","webVisibility"],"description":"The ticket options available for purchase for the show. Each ticket option represents a distinct ticket type with its own price point, description, and availability.","example":{"title":"General Admission","ticketId":"123","description":"General admission ticket","price":100,"currency":"USD","stock":700,"webVisibility":true,"webSoldOut":false,"area":"VIP"}}},"priceTypes":{"type":"array","items":{"type":"object","properties":{"_id":{},"priceTypeId":{"type":"string","minLength":1},"title":{"type":"string"},"description":{"type":"string"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"stock":{"type":"number"},"invisible":{"type":"boolean","default":false},"inventory":{"type":"object","properties":{"releasedTickets":{"type":"number","minimum":0},"reservedSpace":{"type":"number","minimum":0},"soldOut":{"type":"boolean"},"soldPercentage":{"type":"number","minimum":0,"maximum":100}}}},"required":["priceTypeId","webVisibility","invisible"],"description":"The price types available for purchase for the show. Price types represent different pricing tiers or promotional pricing (e.g., Early Bird, VIP, etc.) that can be applied to ticket options.","example":{"title":"Early Birds","description":"Early birds get in for a lower price!","priceTypeId":"123"}}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"kind":{"type":"string","enum":["main","secondary","nft"],"default":"main"},"originalUrl":{"type":"string"}},"required":["url","kind"]},"description":"The images associated with this show. These are used in various user interfaces to represent the show visually.","example":[{"url":"https://www.themasteroftheticket.com/images/shows/179/1.jpg","kind":"main"}]},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Additional configuration options specific to this show, which may override event-level settings."},"showRescheduled":{"type":"boolean","default":false,"example":true,"description":"Indicates whether the show has been rescheduled from its original date. This affects how the show is presented to users and may trigger notifications."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"required":["city","state","venueName","address","country","postalCode"],"description":"The location where the show will take place. This overrides the event-level location if specified.","example":{"address":"123 Main St","city":"Atlanta","state":"GA","raw":"Put here the full address instead of the address, city, state fields, CA","map":{"thumbnail":"https://example.com/thumbnail.jpg","googleMapsUrl":"https://example.com/google-maps-url"},"postalCode":"12345","country":"USA","venueName":"Example Venue"}},"resaleEnabled":{"type":"boolean","default":true,"example":true,"description":"Controls whether tickets for this show can be resold on the secondary marketplace. Set to false to disable resale completely."}},"required":["title","date","showId","ticketOptions","images","configuration","showRescheduled","resaleEnabled"],"description":"Detailed information about the shows or performances that make up this event. An event can have multiple shows, each with its own date, time, and ticket options."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"required":["city","state","venueName","address","country","postalCode"],"description":"The primary location where the event will take place. If shows occur in different locations, specify the location at the show level instead."},"producers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"producerId":{"type":"string"}},"required":["producerId"]},"description":"Information about the organizations or individuals producing the event. This is used for communication, reporting, and access control."},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Global configuration settings that apply to all shows in this event. These can be overridden by show-specific configurations."},"seating":{"type":"object","properties":{"image":{"type":"string"},"svgCode":{"type":"string"}},"description":"Seating chart configuration for venues with assigned seating. This includes section layouts, seat numbering, and other seating-related settings."}},"required":["title","description","externalReferenceId","shows","location","configuration"]},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Create Event Response","description":"Response containing the created event wrapped in the standard API response format"}}}}}},"put":{"tags":["Events"],"summary":"Update an Event","description":"Updates an existing event with new information. This endpoint requires sending the complete updated event object rather than partial updates. All fields will be replaced with the new values provided. Always include the externalReferenceId to identify which event to update. We strongly recommend to send the entire event object rather than partial properties updates.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The main title of the event that will be displayed to users throughout the platform."},"description":{"type":"string","example":"Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.","description":"A detailed description of the event, including relevant information for potential attendees. This supports rich text formatting."},"externalReferenceId":{"type":"string","example":"123","description":"The unique identifier of the event in your ticketing system. This ID is used for all future references to this event."},"shows":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The title of the show, which may differ from the event title if there are multiple performances."},"date":{"type":"string","example":"2024-11-06","description":"The exact date and time when the show starts, in ISO 8601 format. This should include timezone information."},"showId":{"type":"string","example":"123","description":"The unique identifier of the show in your ticketing system. This is used to correlate tickets with specific performances."},"primarySalesUrl":{"type":"string","minLength":1,"example":"https://www.themasteroftheticket.com/event/1234567890/show/179","description":"The direct URL to purchase tickets for this specific show through the primary sales channel. This can be used for redirects from the marketplace."},"status":{"type":"string","enum":["LIVE","CANCELLED"],"example":"LIVE","description":"The current status of the show. A cancelled show will not be available for ticket sales or transfers."},"ticketOptions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"ticketId":{"type":"string"},"description":{"type":"string"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"stock":{"type":"number"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"area":{"type":"string"}},"required":["title","ticketId","description","currency"],"description":"The ticket options available for purchase for the show. Each ticket option represents a distinct ticket type with its own price point, description, and availability.","example":{"title":"General Admission","ticketId":"123","description":"General admission ticket","price":100,"currency":"USD","stock":700,"webVisibility":true,"webSoldOut":false,"area":"VIP"}}},"priceTypes":{"type":"array","items":{"type":"object","properties":{"_id":{},"priceTypeId":{"type":"string","minLength":1},"title":{"type":"string"},"description":{"type":"string"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"stock":{"type":"number"},"invisible":{"type":"boolean","default":false},"inventory":{"type":"object","properties":{"releasedTickets":{"type":"number","minimum":0},"reservedSpace":{"type":"number","minimum":0},"soldOut":{"type":"boolean"},"soldPercentage":{"type":"number","minimum":0,"maximum":100}}}},"required":["priceTypeId"],"description":"The price types available for purchase for the show. Price types represent different pricing tiers or promotional pricing (e.g., Early Bird, VIP, etc.) that can be applied to ticket options.","example":{"title":"Early Birds","description":"Early birds get in for a lower price!","priceTypeId":"123"}}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"kind":{"type":"string","enum":["main","secondary","nft"],"default":"main"},"originalUrl":{"type":"string"}},"required":["url"]},"description":"The images associated with this show. These are used in various user interfaces to represent the show visually.","example":[{"url":"https://www.themasteroftheticket.com/images/shows/179/1.jpg","kind":"main"}]},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Additional configuration options specific to this show, which may override event-level settings."},"showRescheduled":{"type":"boolean","default":false,"example":true,"description":"Indicates whether the show has been rescheduled from its original date. This affects how the show is presented to users and may trigger notifications."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"description":"The location where the show will take place. This overrides the event-level location if specified.","example":{"address":"123 Main St","city":"Atlanta","state":"GA","raw":"Put here the full address instead of the address, city, state fields, CA","map":{"thumbnail":"https://example.com/thumbnail.jpg","googleMapsUrl":"https://example.com/google-maps-url"},"postalCode":"12345","country":"USA","venueName":"Example Venue"}},"resaleEnabled":{"type":"boolean","default":true,"example":true,"description":"Controls whether tickets for this show can be resold on the secondary marketplace. Set to false to disable resale completely."}},"required":["title","date","showId","ticketOptions","images","configuration"],"description":"Detailed information about the shows or performances that make up this event. An event can have multiple shows, each with its own date, time, and ticket options."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"description":"The primary location where the event will take place. If shows occur in different locations, specify the location at the show level instead."},"producers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"producerId":{"type":"string"}},"required":["producerId"]},"description":"Information about the organizations or individuals producing the event. This is used for communication, reporting, and access control."},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Global configuration settings that apply to all shows in this event. These can be overridden by show-specific configurations."},"seating":{"type":"object","properties":{"image":{"type":"string"},"svgCode":{"type":"string"}},"description":"Seating chart configuration for venues with assigned seating. This includes section layouts, seat numbering, and other seating-related settings."}},"required":["externalReferenceId"]}}}},"responses":{"200":{"description":"Event successfully updated with the provided information","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The main title of the event that will be displayed to users throughout the platform."},"description":{"type":"string","example":"Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.","description":"A detailed description of the event, including relevant information for potential attendees. This supports rich text formatting."},"externalReferenceId":{"type":"string","example":"123","description":"The unique identifier of the event in your ticketing system. This ID is used for all future references to this event."},"shows":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The title of the show, which may differ from the event title if there are multiple performances."},"date":{"type":"string","example":"2024-11-06","description":"The exact date and time when the show starts, in ISO 8601 format. This should include timezone information."},"showId":{"type":"string","example":"123","description":"The unique identifier of the show in your ticketing system. This is used to correlate tickets with specific performances."},"primarySalesUrl":{"type":"string","minLength":1,"example":"https://www.themasteroftheticket.com/event/1234567890/show/179","description":"The direct URL to purchase tickets for this specific show through the primary sales channel. This can be used for redirects from the marketplace."},"status":{"type":"string","enum":["LIVE","CANCELLED"],"example":"LIVE","description":"The current status of the show. A cancelled show will not be available for ticket sales or transfers."},"ticketOptions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"ticketId":{"type":"string"},"description":{"type":"string"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"stock":{"type":"number"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"area":{"type":"string"}},"required":["title","ticketId","description","currency","webVisibility"],"description":"The ticket options available for purchase for the show. Each ticket option represents a distinct ticket type with its own price point, description, and availability.","example":{"title":"General Admission","ticketId":"123","description":"General admission ticket","price":100,"currency":"USD","stock":700,"webVisibility":true,"webSoldOut":false,"area":"VIP"}}},"priceTypes":{"type":"array","items":{"type":"object","properties":{"_id":{},"priceTypeId":{"type":"string","minLength":1},"title":{"type":"string"},"description":{"type":"string"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"stock":{"type":"number"},"invisible":{"type":"boolean","default":false},"inventory":{"type":"object","properties":{"releasedTickets":{"type":"number","minimum":0},"reservedSpace":{"type":"number","minimum":0},"soldOut":{"type":"boolean"},"soldPercentage":{"type":"number","minimum":0,"maximum":100}}}},"required":["priceTypeId","webVisibility","invisible"],"description":"The price types available for purchase for the show. Price types represent different pricing tiers or promotional pricing (e.g., Early Bird, VIP, etc.) that can be applied to ticket options.","example":{"title":"Early Birds","description":"Early birds get in for a lower price!","priceTypeId":"123"}}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"kind":{"type":"string","enum":["main","secondary","nft"],"default":"main"},"originalUrl":{"type":"string"}},"required":["url","kind"]},"description":"The images associated with this show. These are used in various user interfaces to represent the show visually.","example":[{"url":"https://www.themasteroftheticket.com/images/shows/179/1.jpg","kind":"main"}]},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Additional configuration options specific to this show, which may override event-level settings."},"showRescheduled":{"type":"boolean","default":false,"example":true,"description":"Indicates whether the show has been rescheduled from its original date. This affects how the show is presented to users and may trigger notifications."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"required":["city","state","venueName","address","country","postalCode"],"description":"The location where the show will take place. This overrides the event-level location if specified.","example":{"address":"123 Main St","city":"Atlanta","state":"GA","raw":"Put here the full address instead of the address, city, state fields, CA","map":{"thumbnail":"https://example.com/thumbnail.jpg","googleMapsUrl":"https://example.com/google-maps-url"},"postalCode":"12345","country":"USA","venueName":"Example Venue"}},"resaleEnabled":{"type":"boolean","default":true,"example":true,"description":"Controls whether tickets for this show can be resold on the secondary marketplace. Set to false to disable resale completely."}},"required":["title","date","showId","ticketOptions","images","configuration","showRescheduled","resaleEnabled"],"description":"Detailed information about the shows or performances that make up this event. An event can have multiple shows, each with its own date, time, and ticket options."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"required":["city","state","venueName","address","country","postalCode"],"description":"The primary location where the event will take place. If shows occur in different locations, specify the location at the show level instead."},"producers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"producerId":{"type":"string"}},"required":["producerId"]},"description":"Information about the organizations or individuals producing the event. This is used for communication, reporting, and access control."},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Global configuration settings that apply to all shows in this event. These can be overridden by show-specific configurations."},"seating":{"type":"object","properties":{"image":{"type":"string"},"svgCode":{"type":"string"}},"description":"Seating chart configuration for venues with assigned seating. This includes section layouts, seat numbering, and other seating-related settings."}},"required":["externalReferenceId"]},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Update Event Response","description":"Response containing the updated event wrapped in the standard API response format"}}}}}}},"/v1/events/:externalReferenceId/cancellation":{"post":{"tags":["Events"],"summary":"Cancel an Event","description":"Cancels an entire event and all associated shows. This action affects all tickets linked to this event and should be used with caution. Once an event is cancelled, all tickets become invalid. Payouts for tickets sold will be cancelled and refunds will be processed for those tickets sold in the secondary market.","parameters":[{"name":"externalReferenceEventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"showId","in":"query","required":false,"schema":{"type":"string"}},{"in":"query","name":"showId","description":"The ID of the show in your system.","schema":{"type":"string","description":"The ID of the show in your system.","example":"456"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Event successfully cancelled with all associated shows","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The main title of the event that will be displayed to users throughout the platform."},"description":{"type":"string","example":"Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.","description":"A detailed description of the event, including relevant information for potential attendees. This supports rich text formatting."},"externalReferenceId":{"type":"string","example":"123","description":"The unique identifier of the event in your ticketing system. This ID is used for all future references to this event."},"shows":{"type":"object","properties":{"title":{"type":"string","example":"Coldplay - Music of the Spheres World Tour","description":"The title of the show, which may differ from the event title if there are multiple performances."},"date":{"type":"string","example":"2024-11-06","description":"The exact date and time when the show starts, in ISO 8601 format. This should include timezone information."},"showId":{"type":"string","example":"123","description":"The unique identifier of the show in your ticketing system. This is used to correlate tickets with specific performances."},"primarySalesUrl":{"type":"string","minLength":1,"example":"https://www.themasteroftheticket.com/event/1234567890/show/179","description":"The direct URL to purchase tickets for this specific show through the primary sales channel. This can be used for redirects from the marketplace."},"status":{"type":"string","enum":["LIVE","CANCELLED"],"example":"LIVE","description":"The current status of the show. A cancelled show will not be available for ticket sales or transfers."},"ticketOptions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"ticketId":{"type":"string"},"description":{"type":"string"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}]},"currency":{"type":"string"},"stock":{"type":"number"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"area":{"type":"string"}},"required":["title","ticketId","description","currency","webVisibility"],"description":"The ticket options available for purchase for the show. Each ticket option represents a distinct ticket type with its own price point, description, and availability.","example":{"title":"General Admission","ticketId":"123","description":"General admission ticket","price":100,"currency":"USD","stock":700,"webVisibility":true,"webSoldOut":false,"area":"VIP"}}},"priceTypes":{"type":"array","items":{"type":"object","properties":{"_id":{},"priceTypeId":{"type":"string","minLength":1},"title":{"type":"string"},"description":{"type":"string"},"webVisibility":{"type":"boolean","default":true},"webSoldOut":{"type":"boolean"},"stock":{"type":"number"},"invisible":{"type":"boolean","default":false},"inventory":{"type":"object","properties":{"releasedTickets":{"type":"number","minimum":0},"reservedSpace":{"type":"number","minimum":0},"soldOut":{"type":"boolean"},"soldPercentage":{"type":"number","minimum":0,"maximum":100}}}},"required":["priceTypeId","webVisibility","invisible"],"description":"The price types available for purchase for the show. Price types represent different pricing tiers or promotional pricing (e.g., Early Bird, VIP, etc.) that can be applied to ticket options.","example":{"title":"Early Birds","description":"Early birds get in for a lower price!","priceTypeId":"123"}}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"kind":{"type":"string","enum":["main","secondary","nft"],"default":"main"},"originalUrl":{"type":"string"}},"required":["url","kind"]},"description":"The images associated with this show. These are used in various user interfaces to represent the show visually.","example":[{"url":"https://www.themasteroftheticket.com/images/shows/179/1.jpg","kind":"main"}]},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Additional configuration options specific to this show, which may override event-level settings."},"showRescheduled":{"type":"boolean","default":false,"example":true,"description":"Indicates whether the show has been rescheduled from its original date. This affects how the show is presented to users and may trigger notifications."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"required":["city","state","venueName","address","country","postalCode"],"description":"The location where the show will take place. This overrides the event-level location if specified.","example":{"address":"123 Main St","city":"Atlanta","state":"GA","raw":"Put here the full address instead of the address, city, state fields, CA","map":{"thumbnail":"https://example.com/thumbnail.jpg","googleMapsUrl":"https://example.com/google-maps-url"},"postalCode":"12345","country":"USA","venueName":"Example Venue"}},"resaleEnabled":{"type":"boolean","default":true,"example":true,"description":"Controls whether tickets for this show can be resold on the secondary marketplace. Set to false to disable resale completely."}},"required":["title","date","showId","ticketOptions","images","configuration","showRescheduled","resaleEnabled"],"description":"Detailed information about the shows or performances that make up this event. An event can have multiple shows, each with its own date, time, and ticket options."},"location":{"type":"object","properties":{"city":{"type":["string","null"],"default":""},"state":{"type":["string","null"],"default":""},"venueName":{"type":["string","null"],"default":""},"address":{"type":["string","null"],"default":""},"country":{"type":["string","null"],"default":""},"postalCode":{"type":["string","null"],"default":""},"timeZone":{"type":"string"},"raw":{"type":"string"},"map":{"type":"object","properties":{"thumbnail":{"type":"string"},"googleMapsUrl":{"type":"string"}}}},"required":["city","state","venueName","address","country","postalCode"],"description":"The primary location where the event will take place. If shows occur in different locations, specify the location at the show level instead."},"producers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"producerId":{"type":"string"}},"required":["producerId"]},"description":"Information about the organizations or individuals producing the event. This is used for communication, reporting, and access control."},"configuration":{"type":"object","properties":{"ticketDelivery":{"type":"object","properties":{"time":{"type":"object","properties":{"when":{"type":"string","enum":["BEFORE","AFTER"]},"seconds":{"type":"number"}},"required":["when","seconds"],"example":{"when":"BEFORE","seconds":10800}}},"required":["time"],"description":"Configuration for ticket delivery timing. Set the time before or after the show when the ticket will be delivered to the customer. This controls when QR codes and other access credentials become available."},"crossBorderPayments":{"type":"object","properties":{"enabled":{"type":"boolean"},"paymentMethods":{"type":"array","items":{"type":"string","enum":["PAYPAL","STRIPE","BANK_TRANSFER"]}}},"required":["enabled","paymentMethods"],"example":{"enabled":true,"paymentMethods":["PAYPAL","STRIPE","BANK_TRANSFER"]},"description":"Configuration for cross-border payments to enable international ticket sales. Only can be used if your environment is configured to accept cross-border payments. This determines which payment methods are available for international customers."},"redemption":{"type":"object","properties":{"policy":{"type":"string","enum":["MANDATORY","OPTIONAL","NONE"]},"instructions":{"type":"string"},"hoursBeforeShow":{"type":"number"}},"required":["policy"],"examples":[{"policy":"MANDATORY","instructions":"You must withdraw your ticket at least 48 hours before the show at the box office. Please present your ID.","hoursBeforeShow":48},{"policy":"OPTIONAL","instructions":"If you wish, you can directly redeem your ticket at the venue. Also, you can withdraw your ticket at the box office the day of the show.","hoursBeforeShow":24},{"policy":"NONE"}],"description":"Configuration for ticket redemption / will call process. If you want to allow or require customers to redeem their tickets at the box office, you can set the policy to MANDATORY or OPTIONAL and provide instructions. This is useful for venues that require physical tickets or wristbands.","default":{"policy":"NONE"}}},"description":"Global configuration settings that apply to all shows in this event. These can be overridden by show-specific configurations."},"seating":{"type":"object","properties":{"image":{"type":"string"},"svgCode":{"type":"string"}},"description":"Seating chart configuration for venues with assigned seating. This includes section layouts, seat numbering, and other seating-related settings."}},"required":["title","description","externalReferenceId","shows","location","configuration"]},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Create Event Response","description":"Response containing the created event wrapped in the standard API response format"}}}}}}},"/v1/events/rules":{"post":{"tags":["Events"],"summary":"Define And Update Event Rules","description":"Creates or updates rules for events, specifying behavior for ticket transfers, resales, and other operations. These rules can control various aspects of ticket lifecycle management.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"externalReferenceEventId":{"type":"string","description":"The ID of the event in your system.","example":"123"},"showId":{"type":"string","description":"The ID of the show in your system.","example":"456"},"ticketOptionId":{"type":"string","description":"The ID of the ticket option in your system.","example":"789"},"priceTypeId":{"type":"string","description":"The ID of the price type in your system.","example":"101"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"description":"The price of the ticket.","example":100},"ruleType":{"type":"string","enum":["EVENT","SHOW","TICKET_OPTION","PRICE_TYPE","COMBINATION","OVERRIDE"],"description":"The type of rule to create or update."},"rules":{"type":"object","properties":{"ticketShield":{"type":"boolean"},"qrUnlock":{"type":"number"},"superSwapUnlock":{"type":"number"},"superswap":{"type":"boolean"},"superSwapConfig":{"type":"object","properties":{"allowListing":{"type":"boolean"},"allowPurchase":{"type":"boolean"}},"required":["allowListing","allowPurchase"]},"superswapInit":{"type":"string"},"maxSell":{"type":["number","null"]},"minPriceSell":{"type":["number","null"]},"maxPriceSell":{"type":["number","null"]},"mentaFees":{"type":"object","properties":{"buyer":{"type":"number"},"seller":{"type":"number"}}},"maxPriceSellConfig":{"type":"object","properties":{"type":{"type":"string","enum":["FIXED","PERCENTAGE"]},"value":{"type":["number","null"]}},"required":["type","value"]},"minPriceSellConfig":{"type":"object","properties":{"type":{"type":"string","enum":["FIXED","PERCENTAGE"]},"value":{"type":["number","null"]}},"required":["type","value"]},"fixedListingPrice":{"type":["number","null"]}},"superSwapConfig":{"allowListing":false,"allowPurchase":false},"maxSell":3}},"required":["externalReferenceEventId","ruleType"],"title":"Create and update rules for an event or show","description":"Validator for creating or updating rules that can be applied at different levels: event, show, ticket option, price type, or combinations. Rules can control pricing and availability constraints."},"title":"Create and update rules for events or shows","description":"An array of rule definitions that can be applied at different levels: event, show, ticket option, price type, or combinations.","examples":[[{"externalReferenceEventId":"123","ruleType":"EVENT","rules":{"superSwapConfig":{"allowListing":false,"allowPurchase":false},"maxSell":3}},{"externalReferenceEventId":"123","showId":"456","ruleType":"SHOW","rules":{"superSwapConfig":{"allowListing":false,"allowPurchase":false},"maxSell":3}}],[{"externalReferenceEventId":"123","showId":"456","ticketOptionId":"789","ruleType":"TICKET_OPTION","rules":{"superSwapConfig":{"allowListing":false,"allowPurchase":false},"maxSell":3}}],[{"externalReferenceEventId":"123","showId":"456","priceTypeId":"101","ruleType":"PRICE_TYPE","rules":{"superSwapConfig":{"allowListing":false,"allowPurchase":false},"maxSell":3}}],[{"externalReferenceEventId":"123","showId":"456","priceTypeId":"101","ruleType":"COMBINATION"}]]}}}},"responses":{"200":{"description":"Rules successfully defined and applied to the events","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"A message describing the result of the operation.","example":"Rules updated successfully"},"externalReferenceEventId":{"type":"string","description":"The ID of the event that was updated.","example":"123"},"success":{"type":"object","properties":{"count":{"type":"number","description":"The number of rules successfully updated.","example":2},"results":{"type":"array","items":{"type":"string"},"description":"Details of each successful rule update.","example":["Updated QrUnlockTime Strategy to 5 for event: test-e2e1747687821385 and showId: e2e-test-1747687821385","Updated SuperSwap Startegy to true for event: test-e2e1747687821385 and ticketOption: 17476878213851"]}},"required":["count","results"],"description":"Success information for the update operation."},"errors":{"type":"object","properties":{"count":{"type":"number","description":"The number of rule updates that failed.","example":0},"results":{"type":"array","items":{"type":"object","properties":{"rule":{"type":"string"},"showId":{"type":"string"},"message":{"type":"string"},"details":{"type":"string"}},"required":["message"]},"description":"Details of each failed rule update.","example":[]}},"required":["count","results"],"description":"Error information for the update operation."}},"required":["message","externalReferenceEventId","success","errors"]}}}}}}},"/v1/tickets":{"post":{"tags":["Tickets"],"summary":"Create a Ticket","description":"Creates new tickets in the menta system. This operation registers your ticket information in the platform for management and distribution. Each ticket receives a unique identifier that links back to your original ticketId. The request body requires an array of ticket objects with all necessary details. This endpoint is asynchronous and will return a response immediately, while the /v1/sync/tickets endpoint is synchronous. Using this endpoint will put your request in the queue to be processed asynchronously. For high volume of tickets, its recommended to use this endpoint as data will be processed as capacity allows.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"externalReferenceEventId":{"type":"string","minLength":1,"description":"The external reference ID of the event this ticket belongs to. This must match an event previously created in the system.","example":"123"},"showId":{"type":["string","null"],"description":"The ID of the specific show or performance this ticket grants access to.","example":"456"},"buyer":{"anyOf":[{"type":"string","format":"email"},{"type":"string","pattern":"^\\+?\\d+$"}],"description":"The email address of the person who purchased the ticket. This is used for communications and to establish initial ownership of the ticket.","example":"example@email.com"},"ticketId":{"type":"string","minLength":1,"description":"The unique identifier for this ticket in your system. This ID will be used in all future references to this ticket and must be unique for each ticket across your system.","example":"444"},"ticketAccess":{"type":"object","properties":{"locator":{"type":"string","description":"The unique access code or barcode value for this ticket. This is used for validation at venue entry points and must be unique across all tickets.","example":"ABC123"},"type":{"type":"string","enum":["URL","BASE64","OTHER"],"description":"The type of access mechanism used for this ticket (e.g., QR, BARCODE, etc). This determines how the ticket will be validated at the venue.","example":"URL"}},"required":["locator","type"],"description":"The access information for this ticket, including its unique locator code and the type of access mechanism used. ","title":"Ticket Access Specification"},"ticketOptionId":{"type":"string","minLength":1,"description":"The identifier of the ticket option type this ticket belongs to. This links the ticket to its pricing tier and descriptions defined in the event.","example":"789"},"priceTypeId":{"type":"string","minLength":1,"description":"The identifier of the price type applied to this ticket (e.g., Early Bird, Standard, VIP). This is used to track different pricing tiers for the same ticket option.","example":"101"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"description":"The original face value price of the ticket in the specified currency. This is the official price set by the event organizer.","example":100},"buyerEmailExternal":{"type":"string","format":"email","description":"(Only use if you are using phone validation) - The email address of the person who purchased the ticket when using phone validation. This is an alternative identifier when email is not the primary contact method.","example":"example@email.com"},"primarySaleBuyerData":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the person who purchased the ticket in the primary sale. This information is used for ticket personalization and verification.","example":"John"},"lastName":{"type":"string","description":"The last name of the person who purchased the ticket in the primary sale. This is used alongside the first name for identification purposes.","example":"Doe"},"identificationType":{"type":"string","description":"The type of identification document provided by the primary buyer (e.g., DNI, Passport, Driver's License). This is used for identity verification at certain venues.","example":"DNI"},"identificationNumber":{"type":"string","description":"The identification number from the buyer's document. This is used to verify the ticket holder's identity at venues requiring ID checks.","example":"123456789"},"phoneNumber":{"type":"string","description":"The contact phone number of the primary buyer. This may be used for notifications or identity verification purposes.","example":"+541144443333"}}},"nominalTicket":{"type":"object","properties":{"fullName":{"type":"string","description":"The full name of the person to whom this ticket is issued. For nominal tickets, this person is the only authorized user of the ticket.","example":"John Doe"},"identification":{"type":"string","description":"The identification number of the person to whom this ticket is issued. This is required for venues that enforce strict ticket personalization.","example":"123456789"}}},"props":{"type":"object","properties":{"seating":{"type":"object","properties":{"row":{"type":["string","null"],"description":"The row of the seat.","example":"A"},"seat":{"type":["string","null"],"description":"The seat of the seat.","example":"1"},"section":{"type":["string","null"],"description":"The section of the seat.","example":"Front stage"},"door":{"type":["string","null"],"description":"The door of the seat.","example":"5"}}},"urls":{"type":"object","properties":{"externalPassbookUrl":{"type":"string","description":"URL to an external passbook or wallet pass for this ticket. This can be used to provide mobile wallet integration for ticket access.","example":"https://example.com/passbook.pdf"},"qrTicketPdfUrl":{"type":"string","description":"URL to a PDF version of the ticket containing the QR code. This can be used for printing physical tickets or for backup access methods.","example":"https://example.com/qr-ticket.pdf"},"qrTicketUrl":{"type":["string","null"],"description":"URL to an online version of the ticket containing the QR code. This can be used for viewing the ticket online. Ideally no authentication is required to access this url.","example":"https://ticketingplatform.com/qr-ticket?keyId=97a3bf9281bddf810b81839-7791-8398719387"}}},"isPartOfAPass":{"type":"boolean","default":false,"description":"Indicates whether this ticket is part of a seasonal or multi-event pass. This affects transfer policies and how the ticket is displayed to users.","example":true},"other":{"type":"object","properties":{"locator":{"type":"string","description":"An additional locator or reference code that can be used to identify this ticket in your system. Often used for order number or booking reference.","example":"ABC123"}}},"attributes":{"type":"array","items":{"type":"string","enum":["OBSTRUCTED_VIEW","PARTIAL_VIEW","RESTRICTED_VIEW","SIDE_VIEW","WHEELCHAIR_ACCESS","COMPANION_SEAT","REMOVABLE_ARMREST","LEVEL_ACCESS","AISLE_SEAT","EXTRA_LEGROOM","HIGH_STOOL","RESTRICTED_LEGROOM"]},"description":"The attributes of the ticket. This is used to describe the ticket in more detail.","example":["OBSTRUCTED_VIEW","WHEELCHAIR_ACCESS","AISLE_SEAT"]}}},"primarySalesFee":{"type":"object","properties":{"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The type of fee structure applied to primary sales of this ticket (percentage or fixed amount). This determines how resale fees are calculated.","example":"PERCENTAGE"},"value":{"type":"number","description":"The value of the primary sale fee (percentage or fixed amount depending on type). This is used to calculate fees on resales.","example":10}},"required":["type","value"]}},"required":["externalReferenceEventId","buyer","ticketId","ticketAccess","ticketOptionId"]},"minItems":1,"maxItems":100,"description":"An array of tickets to create or tokenize in the Menta Tech system. Each ticket object contains all the necessary information to create a digital representation of a physical or electronic ticket.","title":"Ticket's array","example":[{"ticketOptionId":"789","priceTypeId":"101","price":100,"showId":"456","externalReferenceEventId":"123","ticketId":"444","buyer":"example@email.com","ticketAccess":{"locator":"ABC123","type":"URL"},"buyerEmailExternal":"example@email.com","primarySalesFee":{"type":"PERCENTAGE","value":10},"primarySaleBuyerData":{"firstName":"John","lastName":"Doe","identificationType":"DNI","identificationNumber":"123456789","phoneNumber":"+541144443333"},"nominalTicket":{"fullName":"John Doe","identification":"123456789"},"props":{"seating":{"row":"A","seat":"1","section":"Front stage","door":"5"},"urls":{"externalPassbookUrl":"https://example.com/passbook.pdf","qrTicketPdfUrl":"https://example.com/qr-ticket.pdf","qrTicketUrl":"https://ticketingplatform.com/qr-ticket?keyId=97a3bf9281bddf810b81839-7791-8398719387"},"isPartOfAPass":true,"other":{"locator":"ABC123"},"attributes":["OBSTRUCTED_VIEW","WHEELCHAIR_ACCESS","AISLE_SEAT"]}}]}}}},"responses":{"200":{"description":"Tickets successfully created with unique identifiers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"507f1f77bcf86cd799439011","description":"The internal unique identifier for this ticket in the Menta system. Use this ID when interacting with Menta-specific endpoints."},"ticketId":{"type":"string","example":"444","description":"The original external ticket ID provided during creation. This maintains the correlation with your system."},"showId":{"type":"string","example":"456","description":"The ID of the show this ticket grants access to, matching the ID provided during creation."},"externalReferenceEventId":{"type":"string","example":"123","description":"The external reference ID of the event this ticket belongs to, linking it to your event database."},"ticketOptionId":{"type":"string","example":"789","description":"The ID of the ticket option type this ticket belongs to, determining its category and face value."},"priceTypeId":{"type":"string","example":"101","description":"The ID of the price type applied to this ticket, if applicable (e.g., Early Bird, VIP)."},"price":{"type":"number","example":100,"description":"The face value price of the ticket in the specified currency."},"currency":{"type":"string","example":"USD","description":"The three-letter ISO currency code for the ticket price (e.g., USD, EUR, GBP)."},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email","example":"example@email.com","description":"The email address of the original buyer who purchased this ticket in the primary market."},"name":{"type":"string","example":"John","description":"The name of the buyer, if available. This may be used for personalization and communications."}},"required":["email"],"description":"Information about the original purchaser of the ticket in the primary market."},"currentOwnerEmail":{"type":"string","format":"email","example":"example@email.com","description":"The email address of the current ticket owner, which may differ from the buyer if the ticket has been transferred."},"ticketSellerId":{"type":"string","example":"1010","description":"The identifier of the ticket seller or platform that issued this ticket. Used for routing and branding."},"status":{"type":"string","example":"ACTIVE","description":"The current status of the ticket (e.g., ACTIVE, USED, CANCELLED, LISTED). This determines what actions can be performed with the ticket."}},"required":["_id","ticketId","showId","externalReferenceEventId","ticketOptionId","price","currency","currentOwnerEmail","ticketSellerId","status"]},"description":"The array of tickets that were successfully created in the Menta Tech system, including their assigned identifiers and current status.","title":"Tokenized Tickets Response"}}}}}}},"/v1/sync/tickets":{"post":{"tags":["Tickets"],"summary":"Create a Ticket (Sync)","description":"Creates tickets synchronously, returning an immediate response unlike the asynchronous /v1/tickets endpoint. Not suitable for high volume requests. Errors must be handled by your end. <b>Restricted Capacity of 60 requests per minute.</b>","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"externalReferenceEventId":{"type":"string","minLength":1,"description":"The external reference ID of the event this ticket belongs to. This must match an event previously created in the system.","example":"123"},"showId":{"type":["string","null"],"description":"The ID of the specific show or performance this ticket grants access to.","example":"456"},"buyer":{"anyOf":[{"type":"string","format":"email"},{"type":"string","pattern":"^\\+?\\d+$"}],"description":"The email address of the person who purchased the ticket. This is used for communications and to establish initial ownership of the ticket.","example":"example@email.com"},"ticketId":{"type":"string","minLength":1,"description":"The unique identifier for this ticket in your system. This ID will be used in all future references to this ticket and must be unique for each ticket across your system.","example":"444"},"ticketAccess":{"type":"object","properties":{"locator":{"type":"string","description":"The unique access code or barcode value for this ticket. This is used for validation at venue entry points and must be unique across all tickets.","example":"ABC123"},"type":{"type":"string","enum":["URL","BASE64","OTHER"],"description":"The type of access mechanism used for this ticket (e.g., QR, BARCODE, etc). This determines how the ticket will be validated at the venue.","example":"URL"}},"required":["locator","type"],"description":"The access information for this ticket, including its unique locator code and the type of access mechanism used. ","title":"Ticket Access Specification"},"ticketOptionId":{"type":"string","minLength":1,"description":"The identifier of the ticket option type this ticket belongs to. This links the ticket to its pricing tier and descriptions defined in the event.","example":"789"},"priceTypeId":{"type":"string","minLength":1,"description":"The identifier of the price type applied to this ticket (e.g., Early Bird, Standard, VIP). This is used to track different pricing tiers for the same ticket option.","example":"101"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"description":"The original face value price of the ticket in the specified currency. This is the official price set by the event organizer.","example":100},"buyerEmailExternal":{"type":"string","format":"email","description":"(Only use if you are using phone validation) - The email address of the person who purchased the ticket when using phone validation. This is an alternative identifier when email is not the primary contact method.","example":"example@email.com"},"primarySaleBuyerData":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the person who purchased the ticket in the primary sale. This information is used for ticket personalization and verification.","example":"John"},"lastName":{"type":"string","description":"The last name of the person who purchased the ticket in the primary sale. This is used alongside the first name for identification purposes.","example":"Doe"},"identificationType":{"type":"string","description":"The type of identification document provided by the primary buyer (e.g., DNI, Passport, Driver's License). This is used for identity verification at certain venues.","example":"DNI"},"identificationNumber":{"type":"string","description":"The identification number from the buyer's document. This is used to verify the ticket holder's identity at venues requiring ID checks.","example":"123456789"},"phoneNumber":{"type":"string","description":"The contact phone number of the primary buyer. This may be used for notifications or identity verification purposes.","example":"+541144443333"}}},"nominalTicket":{"type":"object","properties":{"fullName":{"type":"string","description":"The full name of the person to whom this ticket is issued. For nominal tickets, this person is the only authorized user of the ticket.","example":"John Doe"},"identification":{"type":"string","description":"The identification number of the person to whom this ticket is issued. This is required for venues that enforce strict ticket personalization.","example":"123456789"}}},"props":{"type":"object","properties":{"seating":{"type":"object","properties":{"row":{"type":["string","null"],"description":"The row of the seat.","example":"A"},"seat":{"type":["string","null"],"description":"The seat of the seat.","example":"1"},"section":{"type":["string","null"],"description":"The section of the seat.","example":"Front stage"},"door":{"type":["string","null"],"description":"The door of the seat.","example":"5"}}},"urls":{"type":"object","properties":{"externalPassbookUrl":{"type":"string","description":"URL to an external passbook or wallet pass for this ticket. This can be used to provide mobile wallet integration for ticket access.","example":"https://example.com/passbook.pdf"},"qrTicketPdfUrl":{"type":"string","description":"URL to a PDF version of the ticket containing the QR code. This can be used for printing physical tickets or for backup access methods.","example":"https://example.com/qr-ticket.pdf"},"qrTicketUrl":{"type":["string","null"],"description":"URL to an online version of the ticket containing the QR code. This can be used for viewing the ticket online. Ideally no authentication is required to access this url.","example":"https://ticketingplatform.com/qr-ticket?keyId=97a3bf9281bddf810b81839-7791-8398719387"}}},"isPartOfAPass":{"type":"boolean","default":false,"description":"Indicates whether this ticket is part of a seasonal or multi-event pass. This affects transfer policies and how the ticket is displayed to users.","example":true},"other":{"type":"object","properties":{"locator":{"type":"string","description":"An additional locator or reference code that can be used to identify this ticket in your system. Often used for order number or booking reference.","example":"ABC123"}}},"attributes":{"type":"array","items":{"type":"string","enum":["OBSTRUCTED_VIEW","PARTIAL_VIEW","RESTRICTED_VIEW","SIDE_VIEW","WHEELCHAIR_ACCESS","COMPANION_SEAT","REMOVABLE_ARMREST","LEVEL_ACCESS","AISLE_SEAT","EXTRA_LEGROOM","HIGH_STOOL","RESTRICTED_LEGROOM"]},"description":"The attributes of the ticket. This is used to describe the ticket in more detail.","example":["OBSTRUCTED_VIEW","WHEELCHAIR_ACCESS","AISLE_SEAT"]}}},"primarySalesFee":{"type":"object","properties":{"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The type of fee structure applied to primary sales of this ticket (percentage or fixed amount). This determines how resale fees are calculated.","example":"PERCENTAGE"},"value":{"type":"number","description":"The value of the primary sale fee (percentage or fixed amount depending on type). This is used to calculate fees on resales.","example":10}},"required":["type","value"]}},"required":["externalReferenceEventId","buyer","ticketId","ticketAccess","ticketOptionId"]},"minItems":1,"maxItems":100,"description":"An array of tickets to create or tokenize in the Menta Tech system. Each ticket object contains all the necessary information to create a digital representation of a physical or electronic ticket.","title":"Ticket's array","example":[{"ticketOptionId":"789","priceTypeId":"101","price":100,"showId":"456","externalReferenceEventId":"123","ticketId":"444","buyer":"example@email.com","ticketAccess":{"locator":"ABC123","type":"URL"},"buyerEmailExternal":"example@email.com","primarySalesFee":{"type":"PERCENTAGE","value":10},"primarySaleBuyerData":{"firstName":"John","lastName":"Doe","identificationType":"DNI","identificationNumber":"123456789","phoneNumber":"+541144443333"},"nominalTicket":{"fullName":"John Doe","identification":"123456789"},"props":{"seating":{"row":"A","seat":"1","section":"Front stage","door":"5"},"urls":{"externalPassbookUrl":"https://example.com/passbook.pdf","qrTicketPdfUrl":"https://example.com/qr-ticket.pdf","qrTicketUrl":"https://ticketingplatform.com/qr-ticket?keyId=97a3bf9281bddf810b81839-7791-8398719387"},"isPartOfAPass":true,"other":{"locator":"ABC123"},"attributes":["OBSTRUCTED_VIEW","WHEELCHAIR_ACCESS","AISLE_SEAT"]}}]}}}},"responses":{"200":{"description":"Tickets successfully synchronized with the system","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","example":"507f1f77bcf86cd799439011","description":"The internal unique identifier for this ticket in the Menta system. Use this ID when interacting with Menta-specific endpoints."},"ticketId":{"type":"string","example":"444","description":"The original external ticket ID provided during creation. This maintains the correlation with your system."},"showId":{"type":"string","example":"456","description":"The ID of the show this ticket grants access to, matching the ID provided during creation."},"externalReferenceEventId":{"type":"string","example":"123","description":"The external reference ID of the event this ticket belongs to, linking it to your event database."},"ticketOptionId":{"type":"string","example":"789","description":"The ID of the ticket option type this ticket belongs to, determining its category and face value."},"priceTypeId":{"type":"string","example":"101","description":"The ID of the price type applied to this ticket, if applicable (e.g., Early Bird, VIP)."},"price":{"type":"number","example":100,"description":"The face value price of the ticket in the specified currency."},"currency":{"type":"string","example":"USD","description":"The three-letter ISO currency code for the ticket price (e.g., USD, EUR, GBP)."},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email","example":"example@email.com","description":"The email address of the original buyer who purchased this ticket in the primary market."},"name":{"type":"string","example":"John","description":"The name of the buyer, if available. This may be used for personalization and communications."}},"required":["email"],"description":"Information about the original purchaser of the ticket in the primary market."},"currentOwnerEmail":{"type":"string","format":"email","example":"example@email.com","description":"The email address of the current ticket owner, which may differ from the buyer if the ticket has been transferred."},"ticketSellerId":{"type":"string","example":"1010","description":"The identifier of the ticket seller or platform that issued this ticket. Used for routing and branding."},"status":{"type":"string","example":"ACTIVE","description":"The current status of the ticket (e.g., ACTIVE, USED, CANCELLED, LISTED). This determines what actions can be performed with the ticket."}},"required":["_id","ticketId","showId","externalReferenceEventId","ticketOptionId","price","currency","currentOwnerEmail","ticketSellerId","status"]},"description":"The array of tickets that were successfully created in the Menta Tech system, including their assigned identifiers and current status.","title":"Tokenized Tickets Response"}}}}}}},"/v1/tickets/:ticketId":{"put":{"tags":["Tickets"],"summary":"Update a Ticket","description":"Updates an existing ticket's properties. This can be used to modify ticket access information, update buyer details, or change other ticket properties after initial creation. The ticket is identified by its ID provided in the path parameter.","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"externalReferenceEventId":{"type":"string","minLength":1,"description":"The external reference ID of the event this ticket belongs to. This must match an event previously created in the system.","example":"123"},"showId":{"type":["string","null"],"description":"The ID of the specific show or performance this ticket grants access to.","example":"456"},"buyer":{"anyOf":[{"type":"string","format":"email"},{"type":"string","pattern":"^\\+?\\d+$"}],"description":"The email address of the person who purchased the ticket. This is used for communications and to establish initial ownership of the ticket.","example":"example@email.com"},"ticketAccess":{"type":"object","properties":{"locator":{"type":"string","description":"The unique access code or barcode value for this ticket. This is used for validation at venue entry points and must be unique across all tickets.","example":"ABC123"},"type":{"type":"string","enum":["URL","BASE64","OTHER"],"description":"The type of access mechanism used for this ticket (e.g., QR, BARCODE, etc). This determines how the ticket will be validated at the venue.","example":"URL"}},"required":["locator","type"],"description":"The access information for this ticket, including its unique locator code and the type of access mechanism used. ","title":"Ticket Access Specification"},"ticketOptionId":{"type":"string","minLength":1,"description":"The identifier of the ticket option type this ticket belongs to. This links the ticket to its pricing tier and descriptions defined in the event.","example":"789"},"priceTypeId":{"type":"string","minLength":1,"description":"The identifier of the price type applied to this ticket (e.g., Early Bird, Standard, VIP). This is used to track different pricing tiers for the same ticket option.","example":"101"},"price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"description":"The original face value price of the ticket in the specified currency. This is the official price set by the event organizer.","example":100},"buyerEmailExternal":{"type":"string","format":"email","description":"(Only use if you are using phone validation) - The email address of the person who purchased the ticket when using phone validation. This is an alternative identifier when email is not the primary contact method.","example":"example@email.com"},"primarySaleBuyerData":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the person who purchased the ticket in the primary sale. This information is used for ticket personalization and verification.","example":"John"},"lastName":{"type":"string","description":"The last name of the person who purchased the ticket in the primary sale. This is used alongside the first name for identification purposes.","example":"Doe"},"identificationType":{"type":"string","description":"The type of identification document provided by the primary buyer (e.g., DNI, Passport, Driver's License). This is used for identity verification at certain venues.","example":"DNI"},"identificationNumber":{"type":"string","description":"The identification number from the buyer's document. This is used to verify the ticket holder's identity at venues requiring ID checks.","example":"123456789"},"phoneNumber":{"type":"string","description":"The contact phone number of the primary buyer. This may be used for notifications or identity verification purposes.","example":"+541144443333"}}},"nominalTicket":{"type":"object","properties":{"fullName":{"type":"string","description":"The full name of the person to whom this ticket is issued. For nominal tickets, this person is the only authorized user of the ticket.","example":"John Doe"},"identification":{"type":"string","description":"The identification number of the person to whom this ticket is issued. This is required for venues that enforce strict ticket personalization.","example":"123456789"}}},"props":{"type":"object","properties":{"seating":{"type":"object","properties":{"row":{"type":["string","null"],"description":"The row of the seat.","example":"A"},"seat":{"type":["string","null"],"description":"The seat of the seat.","example":"1"},"section":{"type":["string","null"],"description":"The section of the seat.","example":"Front stage"},"door":{"type":["string","null"],"description":"The door of the seat.","example":"5"}}},"urls":{"type":"object","properties":{"externalPassbookUrl":{"type":"string","description":"URL to an external passbook or wallet pass for this ticket. This can be used to provide mobile wallet integration for ticket access.","example":"https://example.com/passbook.pdf"},"qrTicketPdfUrl":{"type":"string","description":"URL to a PDF version of the ticket containing the QR code. This can be used for printing physical tickets or for backup access methods.","example":"https://example.com/qr-ticket.pdf"},"qrTicketUrl":{"type":["string","null"],"description":"URL to an online version of the ticket containing the QR code. This can be used for viewing the ticket online. Ideally no authentication is required to access this url.","example":"https://ticketingplatform.com/qr-ticket?keyId=97a3bf9281bddf810b81839-7791-8398719387"}}},"isPartOfAPass":{"type":"boolean","default":false,"description":"Indicates whether this ticket is part of a seasonal or multi-event pass. This affects transfer policies and how the ticket is displayed to users.","example":true},"other":{"type":"object","properties":{"locator":{"type":"string","description":"An additional locator or reference code that can be used to identify this ticket in your system. Often used for order number or booking reference.","example":"ABC123"}}},"attributes":{"type":"array","items":{"type":"string","enum":["OBSTRUCTED_VIEW","PARTIAL_VIEW","RESTRICTED_VIEW","SIDE_VIEW","WHEELCHAIR_ACCESS","COMPANION_SEAT","REMOVABLE_ARMREST","LEVEL_ACCESS","AISLE_SEAT","EXTRA_LEGROOM","HIGH_STOOL","RESTRICTED_LEGROOM"]},"description":"The attributes of the ticket. This is used to describe the ticket in more detail.","example":["OBSTRUCTED_VIEW","WHEELCHAIR_ACCESS","AISLE_SEAT"]}}},"primarySalesFee":{"type":"object","properties":{"type":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The type of fee structure applied to primary sales of this ticket (percentage or fixed amount). This determines how resale fees are calculated.","example":"PERCENTAGE"},"value":{"type":"number","description":"The value of the primary sale fee (percentage or fixed amount depending on type). This is used to calculate fees on resales.","example":10}},"required":["type","value"]}},"title":"Update a Ticket","description":"Update a ticket. This endpoint allows you to modify the display information of an existing ticket without changing its core properties like ownership or validity.","examples":[{"ticketOptionId":"444","price":100,"buyer":"example@email.com"}]}}}},"responses":{"200":{"description":"Ticket successfully updated with new information","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","example":"507f1f77bcf86cd799439011","description":"The internal Menta system ID for the updated ticket."},"ticketId":{"type":"string","example":"444","description":"The external ticket identifier from your system, unchanged from the original."},"showId":{"type":"string","example":"456","description":"The ID of the show this ticket grants access to, which may have been updated if the ticket was moved to a different show."},"externalReferenceEventId":{"type":"string","example":"123","description":"The external reference ID of the event this ticket belongs to, which remains consistent with the event identification."},"ticketOptionId":{"type":"string","example":"789","description":"The ID of the ticket option type, which may have been updated if the ticket category changed."},"price":{"type":"number","example":100,"description":"The current face value price of the ticket, which may reflect updates to the pricing."},"currency":{"type":"string","example":"USD","description":"The currency code for the ticket price, consistent with the event currency."},"buyer":{"type":"object","properties":{"email":{"type":"string","format":"email","example":"example@email.com","description":"The email of the original buyer, which is typically not changed even if ownership transfers."},"name":{"type":"string","example":"John","description":"The name of the original buyer, if available."}},"required":["email"],"description":"Information about the original purchaser, preserved for record-keeping."},"currentOwnerEmail":{"type":"string","format":"email","example":"example@email.com","description":"The email of the current owner, which may have been updated if the ticket was transferred."},"ticketSellerId":{"type":"string","example":"1010","description":"The platform identifier that issued or is managing this ticket."},"status":{"type":"string","example":"ACTIVE","description":"The current status of the ticket after the update, reflecting any changes in its state."}},"required":["_id","ticketId","showId","externalReferenceEventId","ticketOptionId","price","currency","currentOwnerEmail","ticketSellerId","status"],"description":"The complete updated ticket object reflecting all changes made during the update operation.","title":"Updated Ticket Response"}}}}}},"delete":{"tags":["Tickets"],"summary":"Delete a Ticket","description":"Removes a ticket from the system, invalidating it for all purposes. This operation is typically used for tickets that were issued in error or need to be cancelled for specific reasons. If any listing is active, it will be terminated. Use with caution as this operation cannot be undone.","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Ticket successfully deleted from the system"}}}},"/v1/tickets/:ticketId/eventAdmission":{"post":{"tags":["Tickets"],"summary":"Register Event Admission","description":"Records a ticket admission at an event, marking the ticket as used. This is typically called by access control systems at venue entrances. The ticketId is provided in the URL path parameter.","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Admission successfully registered for the ticket","content":{"application/json":{"schema":{"type":"boolean","example":true}}}}}}},"/v1/tickets/batch/eventAdmission":{"post":{"tags":["Tickets"],"summary":"Register Batch Event Admissions","description":"Records multiple ticket admissions at an event in a single request. This is more efficient than making individual calls for each ticket when processing groups of attendees. The response indicates whether all admissions were successfully recorded.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","description":"The ID of the ticket in your system.","example":"444"},"entryDate":{"type":"string","description":"The date of the entry in the event.","example":"2024-11-06"}},"required":["ticketId","entryDate"]},"title":"Batch event admission","description":"Validate multiple ticket admissions at an event by marking the tickets as used.","examples":[[{"ticketId":"444","entryDate":"2024-11-06"}]]}}}},"responses":{"200":{"description":"Batch admission successfully executed for all provided tickets","content":{"application/json":{"schema":{"type":"boolean","example":true}}}}}}},"/v1/events/tickets/salePublicUrl":{"get":{"tags":["Tickets"],"summary":"Get Ticket Sale Public URL","description":"Retrieves a public URL that directs users directly to the secondary marketplace for the event, filtered to show only the specific ticket. This URL is commonly used for direct ticket sales, especially to enable ticket sellers to share the URL through social media platforms to amplify the distribution and visibility of their ticket listing. When a potential buyer clicks the link, they are taken directly to the marketplace page showing only that specific ticket, making it easy to complete the purchase.","parameters":[{"name":"ticketId","in":"query","required":true,"schema":{"type":"string"}},{"name":"lang","in":"query","required":true,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Successfully generated public sales URL","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"string","example":"https://event.mentatickets.com/es/688a19c45564c6243865fad7/show/1753881027917?ticketSellerId=2&sellerId=65d399f9094b9bfbf95e103a","description":"The public URL for ticket sales"},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Events Tickets Sale Public Url Response","description":"Response containing the public URL for ticket sales"}}}}}}},"/v1/marketplace/buyingflow/url/entrypoint":{"get":{"tags":["Marketplace"],"summary":"Get Secondary Market Buying Flow URL","description":"Retrieves the entry URL to access the secondary marketplace for purchasing tickets for the event and show specified in the query parameters. This URL directs users to the marketplace interface where they can browse and purchase available tickets from the secondary market. The marketplace provides a secure environment for secondary ticket sales with buyer and seller protections. You can optionally filter the listings by a specific ticket option ID to show only offers for that ticket type.","parameters":[{"in":"query","name":"externalReferenceEventId","description":"The ID of the event in your platform. This identifies which event the user will browse in the secondary marketplace.","schema":{"type":"string","description":"The ID of the event in your platform. This identifies which event the user will browse in the secondary marketplace.","example":"123"},"required":true},{"in":"query","name":"showId","description":"The ID of the show in your platform. This identifies the specific show within the event that the user will browse.","schema":{"type":"string","description":"The ID of the show in your platform. This identifies the specific show within the event that the user will browse.","example":"456"},"required":true},{"in":"query","name":"lang","description":"Language code for the navigation interface (e.g., \"es\", \"en\"). If not specified, it defaults to the primary language of the country of operation.","schema":{"type":"string","description":"Language code for the navigation interface (e.g., \"es\", \"en\"). If not specified, it defaults to the primary language of the country of operation.","example":"es"}},{"in":"query","name":"returnTo","description":"The URL to redirect users to when they press the back button or complete the purchase flow. This allows you to return users to your platform after they interact with the marketplace.","schema":{"type":"string","description":"The URL to redirect users to when they press the back button or complete the purchase flow. This allows you to return users to your platform after they interact with the marketplace.","example":"https://example.com"},"required":true},{"in":"query","name":"ticketOptionId","description":"Optional filter to show only secondary market purchase offers for the specified ticket type ID. When provided, the marketplace will display listings filtered to this specific ticket option.","schema":{"type":"string","description":"Optional filter to show only secondary market purchase offers for the specified ticket type ID. When provided, the marketplace will display listings filtered to this specific ticket option.","example":"789"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Successfully generated buying flow entry URL","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"string","example":"https://events.mentatech.io/es/123/456?ticketSellerId=1010","description":"The public URL for ticket sales"},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Marketplace Buyingflow Url Entrypoint Response","description":"Response containing the public URL for ticket sales"}}}}}}},"/v1/marketplace/items/events/:eventId/listedTickets":{"get":{"tags":["Build Your Own Buyingflow"],"summary":"Get Listed Tickets for Event","description":"Retrieves all tickets currently listed for sale for a specific event. This allows integration with your platform to display available secondary market tickets. The response includes pricing, seat information, and other details necessary for presenting the listings to potential buyers.","parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","name":"showId","schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Successfully retrieved all listed tickets for the event","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"number","example":5,"description":"Total count of listed tickets for the event"},"bestListing":{"type":"object","properties":{"price":{"type":"number","example":230,"description":"Price of the ticket listing"},"groupId":{"type":"string","example":"68cce0416fb69b31b11e2942","description":"Group ID for the listing"},"currency":{"type":"string","example":"USD","description":"Currency code for the price"},"ticketOptionId":{"type":"string","example":"2052052","description":"ID of the ticket option"},"listingId":{"type":"string","example":"68cce0416fb69b31b11e2950","description":"Unique listing identifier"},"type":{"type":"string","enum":["SINGLE","MULTI","PACK"],"example":"PACK","description":"Type of listing"},"seating":{"type":"object","properties":{"section":{"type":"string","example":"GENERAL","description":"Seating section"},"row":{"type":"string","example":"13","description":"Seating row"},"seat":{"type":"string","example":"F","description":"Seating seat"}},"required":["section","row","seat"],"description":"Seating information for the ticket"},"ticketId":{"type":"string","example":"T6FE307CAEF767D","description":"External ticket ID (from your system)"}},"required":["price","groupId","currency","ticketOptionId","listingId","type","seating","ticketId"],"description":"The best listing available for the event based on price or other criteria"},"results":{"type":"array","items":{"type":"object","properties":{"listings":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number","example":230,"description":"Price of the ticket listing"},"groupId":{"type":"string","example":"68cce0416fb69b31b11e2942","description":"Group ID for the listing"},"currency":{"type":"string","example":"USD","description":"Currency code for the price"},"ticketOptionId":{"type":"string","example":"2052052","description":"ID of the ticket option"},"listingId":{"type":"string","example":"68cce0416fb69b31b11e2950","description":"Unique listing identifier"},"type":{"type":"string","enum":["SINGLE","MULTI","PACK"],"example":"PACK","description":"Type of listing"},"seating":{"type":"object","properties":{"section":{"type":"string","example":"GENERAL","description":"Seating section"},"row":{"type":"string","example":"13","description":"Seating row"},"seat":{"type":"string","example":"F","description":"Seating seat"}},"required":["section","row","seat"],"description":"Seating information for the ticket"},"ticketId":{"type":"string","example":"T6FE307CAEF767D","description":"External ticket ID (from your system)"}},"required":["price","groupId","currency","ticketOptionId","listingId","type","seating","ticketId"]},"description":"All available listings for this ticket option"},"count":{"type":"number","example":2,"description":"Number of tickets available for this option"},"ticketOptionId":{"type":"string","example":"2052052","description":"ID of the ticket option"},"bestListing":{"type":"object","properties":{"price":{"type":"number","example":230,"description":"Price of the ticket listing"},"groupId":{"type":"string","example":"68cce0416fb69b31b11e2942","description":"Group ID for the listing"},"currency":{"type":"string","example":"USD","description":"Currency code for the price"},"ticketOptionId":{"type":"string","example":"2052052","description":"ID of the ticket option"},"listingId":{"type":"string","example":"68cce0416fb69b31b11e2950","description":"Unique listing identifier"},"type":{"type":"string","enum":["SINGLE","MULTI","PACK"],"example":"PACK","description":"Type of listing"},"seating":{"type":"object","properties":{"section":{"type":"string","example":"GENERAL","description":"Seating section"},"row":{"type":"string","example":"13","description":"Seating row"},"seat":{"type":"string","example":"F","description":"Seating seat"}},"required":["section","row","seat"],"description":"Seating information for the ticket"},"ticketId":{"type":"string","example":"T6FE307CAEF767D","description":"External ticket ID (from your system)"}},"required":["price","groupId","currency","ticketOptionId","listingId","type","seating","ticketId"],"description":"The best listing available for this ticket option"}},"required":["listings","count","ticketOptionId","bestListing"]},"description":"Grouped results by ticket option"}},"required":["totalCount","bestListing","results"]}}}}}}},"/v1/marketplace/buyingflow/buyIntention":{"post":{"tags":["Build Your Own Buyingflow"],"summary":"Create Buy Intention","description":"A Buy Intention is a representation of a user's intention to purchase specific tickets. This creates a temporary reservation to prevent conflicts during the checkout process. Buy intentions have a limited lifetime and will expire if the purchase is not completed within a certain timeframe. You can use this endpoint to create a buy intention for specific tickets and retrieve the payment URL to complete the purchase.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string","description":"The ID of the listing in our system.","example":"123"}},"user":{"type":"string","description":"The email address of the person who purchased the ticket.","example":"example@email.com"}},"required":["items","user"],"title":"Marketplace buyingflow buy intention","description":"Create a buy intention for a list of items.","examples":[{"items":["123"],"user":"example@email.com"}]}}}},"responses":{"200":{"description":"Purchase intention successfully registered","content":{"application/json":{"schema":{"type":"object","properties":{"continueUrl":{"type":"string","example":"https://checkout.mentatech.io","description":"URL to continue the checkout process. You have to redirect the user to this URL to complete the purchase."},"_id":{"type":"string","example":"12432423","description":"The menta Buy Intention ID"},"attachedCart":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string","description":"The ID of the listing in our system.","example":"123"}},"expiresAt":{"type":"string","example":"2024-11-06","description":"Cart expiration date"},"_id":{"type":"string","example":"4343242342","description":"The menta cart ID"}},"required":["items","expiresAt","_id"]},"details":{"type":"object","properties":{"total":{"type":"number","description":"The price of the ticket.","example":100},"currency":{"type":"string","example":"MXN","description":"Currency code"}},"required":["total","currency"]}},"required":["continueUrl","_id","attachedCart","details"]}}}}}}},"/v1/marketplace/sellingflow/url/entrypoint":{"get":{"tags":["Marketplace"],"summary":"Get Start Sell Ticket URL","description":"Retrieves the URL to begin the process of selling tickets in the marketplace. This URL directs users to an interface where they can set pricing, listing conditions, and other parameters for their ticket listings. The process includes verification steps to ensure ticket validity.","parameters":[{"name":"ticketId","in":"query","required":true,"schema":{"type":"string"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Successfully generated URL for the selling flow","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"string","example":"https://sell-ticket.mentatech.io/es/publish/444?ticketSellerId=1010","description":"The public URL for starting the selling flow"},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Marketplace Sellingflow Url Entrypoint Response","description":"Response containing the public URL for starting the selling flow"}}}}}}},"/v1/marketplace/sellingflow/url/order/entrypoint":{"get":{"tags":["Marketplace"],"summary":"Get Start Sell Order URL","description":"Retrieves the URL to start the sales order process for multiple tickets in a single transaction. This is particularly useful for selling groups of tickets or complete orders from the primary market. The generated URL leads to a specialized interface for creating these bulk listings.","parameters":[{"name":"orderId","in":"query","required":true,"schema":{"type":"string"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Successfully generated URL for starting the sales order process","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"string","example":"https://sell-ticket.mentatech.io/es/publish/444?ticketSellerId=1010&oneTimeToken=4238421843090481938491834&returnUrl=https://example.com","description":"The public URL for starting the sales order process"},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Marketplace Sellingflow Url Order Entrypoint Response","description":"Response containing the public URL for starting the sales order process"}}}}}}},"/v1/marketplace/sellingflow/details/url":{"get":{"tags":["Marketplace"],"summary":"Get Sell Ticket Details URL","description":"Retrieves the URL for viewing and managing details of a ticket listing. This allows ticket owners to check the status of their listings, modify pricing, or remove listings from the marketplace. The URL can include authentication parameters for direct access.","parameters":[{"name":"ticketId","in":"query","required":true,"schema":{"type":"string"}},{"name":"sellerEmail","in":"query","required":false,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Successfully generated URL for selling details","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"string","example":"https://ticket-info.mentatech.io/es/444/listing?ticketSellerId=1010&oneTimeToken=4238421843090481938491834&returnUrl=https://example.com","description":"The public URL to view ticket listing details"},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Marketplace Sellingflow Details Url Response","description":"Response containing the public URL to view ticket listing details"}}}}}}},"/v1/marketplace/checkout/url":{"post":{"tags":["Marketplace"],"summary":"Create Marketplace Checkout URL","description":"Creates and retrieves a checkout URL for marketplace purchases. This URL directs users to complete their purchase of selected tickets from the secondary market. The checkout process handles payment processing, buyer verification, and ticket transfer in a secure environment. The request requires a list of ticket listing IDs to purchase that you can get from the Get Listed Tickets for Event endpoint.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"listingIds":{"type":"array","items":{"type":"string","description":"The ID of the listing in our system.","example":"123"}}},"required":["listingIds"],"title":"Marketplace checkout url","description":"Get the public URL to checkout a list of ticket listings.","examples":[{"listingIds":["123"]}]}}}},"responses":{"200":{"description":"Successfully generated checkout URL for the marketplace purchase","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","example":200,"description":"HTTP status code"},"data":{"type":"string","example":"https://checkout.mentatech.io/es/buyingflow/start/intention/12432423?ticketSellerId=1010&returnUrl=https://example.com","description":"The public URL to checkout a list of ticket listings"},"errors":{"type":"null","example":null,"description":"Error information, null if the request was successful"}},"required":["status","data","errors"],"title":"Marketplace Checkout Url Response","description":"Response containing the public URL to checkout a list of ticket listings"}}}}}}},"/v1/marketplace/items/ticket/:ticketId":{"delete":{"tags":["Marketplace"],"summary":"Terminate Listing","description":"Removes a ticket from the marketplace listings, making it unavailable for purchase. This is typically used when a seller wants to cancel their listing without completing a sale. The ticket reverts to its unlisted state and can be used by the owner or listed again later.","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Ticket successfully removed from marketplace listings","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","example":"507f1f77bcf86cd799439011","description":"The ID of the removed listing"}},"required":["_id"],"description":"The removed listing information"}}}}}}},"/v1/marketplace/listings/ticket/:ticketId":{"get":{"tags":["Marketplace"],"summary":"Get Listing by Ticket ID","description":"Retrieves a listing by its external ticket ID. This allows you to access information about a specific ticket listing in the marketplace. You can also filter by seller email if you want to get the listing for a specific seller.","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string"}},{"in":"query","name":"sellerEmail","schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Successfully retrieved listing by ticket ID","content":{"application/json":{"schema":{"type":"object","properties":{"sellerEmail":{"type":"string","example":"example@email.com","description":"Email of the seller"},"buyerEmail":{"type":"string","example":"example@email.com","description":"Email of the buyer (only if it was sold)"},"listingId":{"type":"string","description":"The ID of the listing in our system.","example":"123"},"ticketId":{"type":"string","description":"The ID of the ticket in your system.","example":"444"},"price":{"type":"number","example":4500,"description":"Price listed by the seller"},"finalPrice":{"type":"number","example":5175,"description":"Final price (includes fees/commissions)"},"listedAt":{"type":"string","example":"2025-09-04T22:58:24.431Z","description":"Publication date (ISO 8601)"},"soldAt":{"type":"string","example":"2025-09-04T23:26:32.051Z","description":"Sale date (ISO 8601) when applies"},"status":{"type":"string","enum":["ACTIVE","CANCELLED","SOLD"],"example":"SOLD","description":"Current status of the listing"},"type":{"type":"string","enum":["SINGLE","MULTI","PACK"],"example":"MULTI","description":"Type of listing"},"groupId":{"type":"string","example":"68ba19907f353edbb8005c4c","description":"Group ID to link multiple listings."}},"required":["sellerEmail","listingId","ticketId","price","finalPrice","listedAt","status","type"],"description":"Information about the listing of the given ticketId"}}}}}}},"/v1/auth/oneTimeToken":{"get":{"tags":["Auth"],"summary":"Generate One-Time Token","description":"Creates a one-time authentication token for a specific user. This token can be appended to any menta URL to provide temporary authenticated access. It's useful for redirecting users from your platform to specific menta functions while maintaining their authenticated state. The token is designed for single use and will expire after being used or after a predetermined time period.","parameters":[{"name":"user","in":"query","required":true,"schema":{"type":"string"}},{"name":"method","in":"query","required":false,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"One-time token successfully generated","content":{"application/json":{"schema":{"type":"object","properties":{"oneTimeToken":{"type":"string","example":"4238421843090481938491834","description":"The generated one-time token that can be used for authentication. This token should be appended to menta URLs as a query parameter named \"oneTimeToken\"."}},"required":["oneTimeToken"]}}}}}}},"/v1/wrapper/accesslayer":{"get":{"tags":["Smart Access Layer"],"summary":"Get Smart Access Layer","description":"Retrieves smart access layer components for a specific event and show. These components provide dynamic UI elements (buttons, banners, modals, lists, maps) that can be rendered in your application to enable buy/sell access points. The components are configured based on event rules and marketplace conditions. When type=\"buy\", both eventId and showId are required.","parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"query","required":false,"schema":{"type":"string"}},{"name":"showId","in":"query","required":false,"schema":{"type":"string"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"responses":{"200":{"description":"Successfully retrieved smart access layer components","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP status code","example":200},"data":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"Component ID","example":"component123"},"type":{"type":"string","enum":["button","text","banner","modal","flashMessage","list","map"],"description":"Component type","example":"button"},"class":{"type":"string","enum":["buyBanner","buyModal","buyButton","categoriesList","integratedMap"],"description":"Component class/style identifier","example":"buyButton"},"buyButton":{"type":"object","properties":{"visible":{"type":"boolean","description":"Whether the buy button is visible","example":true},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["visible","callToAction"]},"buyBanner":{"type":"object","properties":{"title":{"type":"string","description":"Banner title","example":"Buy Tickets Now"},"description":{"type":"string","description":"Banner description","example":"Get the best seats for this event"},"image":{"type":"string","description":"Banner image URL","example":"https://example.com/banner.jpg"},"visible":{"type":"boolean","description":"Whether the banner is visible","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]}},"required":["title","description","image","visible","callToAction"]},"buyModal":{"type":"object","properties":{"title":{"type":"string","description":"Modal title","example":"Purchase Tickets"},"description":{"type":"string","description":"Modal description","example":"Complete your purchase"},"image":{"type":"string","description":"Modal image URL","example":"https://example.com/modal.jpg"},"visible":{"type":"boolean","description":"Whether the modal is visible","example":true},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["title","description","image","visible","callToAction"]},"categoriesList":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"ticketOptionId":{"type":"string","description":"Ticket option ID","example":"789"},"quantityForSale":{"type":"number","description":"Number of tickets available for sale","example":10},"floorPrice":{"type":"number","description":"Minimum price for tickets in this category","example":100},"visible":{"type":"boolean","description":"Whether this category is visible","example":true},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["ticketOptionId","quantityForSale","floorPrice","visible"]},"description":"List of ticket categories"}},"required":["categories"]},"integratedMap":{"type":"object","properties":{"map":{"type":"object","properties":{"config":{"type":"object","properties":{"allowOrphanTicketSelection":{"type":"boolean","description":"Whether orphan ticket selection is allowed","example":false}},"required":["allowOrphanTicketSelection"]},"totalCount":{"type":"number","description":"Total count of available listings","example":25},"bestListing":{"type":"object","properties":{"price":{"type":"number","description":"Listing price","example":100},"groupId":{"type":"string","description":"Group ID for the listing","example":"group123"},"currency":{"type":"string","description":"Currency code","example":"MXN"},"ticketOptionId":{"type":"string","description":"Ticket option ID","example":"789"},"priceTypeId":{"type":"string","description":"Price type ID","example":"101"},"listingId":{"type":"string","description":"Listing ID","example":"123"},"type":{"type":"string","description":"Listing type","example":"SINGLE"},"seating":{"type":"object","properties":{"section":{"type":"string","description":"Seating section","example":"Front stage"},"row":{"type":"string","description":"Seating row","example":"A"},"seat":{"type":"string","description":"Seating seat","example":"1"},"door":{"type":"string","description":"Seating door","example":"5"},"image":{"type":"string","description":"Seating image URL","example":"https://example.com/image.jpg"}}},"ticketId":{"type":"string","description":"Ticket ID","example":"444"}},"required":["price","groupId","currency","ticketOptionId","listingId","type","ticketId"]},"results":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number","description":"Number of listings in this result","example":5},"ticketOptionId":{"type":"string","description":"Ticket option ID","example":"789"},"visible":{"type":"boolean","description":"Whether this result is visible","example":true},"bestListing":{"type":"object","properties":{"price":{"type":"number","description":"Listing price","example":100},"groupId":{"type":"string","description":"Group ID for the listing","example":"group123"},"currency":{"type":"string","description":"Currency code","example":"MXN"},"ticketOptionId":{"type":"string","description":"Ticket option ID","example":"789"},"priceTypeId":{"type":"string","description":"Price type ID","example":"101"},"listingId":{"type":"string","description":"Listing ID","example":"123"},"type":{"type":"string","description":"Listing type","example":"SINGLE"},"seating":{"type":"object","properties":{"section":{"type":"string","description":"Seating section","example":"Front stage"},"row":{"type":"string","description":"Seating row","example":"A"},"seat":{"type":"string","description":"Seating seat","example":"1"},"door":{"type":"string","description":"Seating door","example":"5"},"image":{"type":"string","description":"Seating image URL","example":"https://example.com/image.jpg"}}},"ticketId":{"type":"string","description":"Ticket ID","example":"444"}},"required":["price","groupId","currency","ticketOptionId","listingId","type","ticketId"]},"listings":{"type":"array","items":{"type":"object","properties":{"price":{"type":"number","description":"Listing price","example":100},"groupId":{"type":"string","description":"Group ID for the listing","example":"group123"},"currency":{"type":"string","description":"Currency code","example":"MXN"},"ticketOptionId":{"type":"string","description":"Ticket option ID","example":"789"},"priceTypeId":{"type":"string","description":"Price type ID","example":"101"},"listingId":{"type":"string","description":"Listing ID","example":"123"},"type":{"type":"string","description":"Listing type","example":"SINGLE"},"seating":{"type":"object","properties":{"section":{"type":"string","description":"Seating section","example":"Front stage"},"row":{"type":"string","description":"Seating row","example":"A"},"seat":{"type":"string","description":"Seating seat","example":"1"},"door":{"type":"string","description":"Seating door","example":"5"},"image":{"type":"string","description":"Seating image URL","example":"https://example.com/image.jpg"}}},"ticketId":{"type":"string","description":"Ticket ID","example":"444"}},"required":["price","groupId","currency","ticketOptionId","listingId","type","ticketId"]},"description":"List of all listings for this ticket option"}},"required":["count","ticketOptionId","visible","listings"]},"description":"Map results grouped by ticket option"}},"required":["config","totalCount","results"]}},"required":["map"]}},"required":["type","class"]},"description":"Array of smart access layer components that can be rendered in your application"}},"required":["status","data"],"title":"Smart Access Layer Response","description":"Response containing status code and array of smart access layer components"}}}}}},"post":{"tags":["Smart Access Layer"],"summary":"Generate Sell Access Layer for TicketIds","description":"Evaluates the sellability of a user's tickets and returns the corresponding status and call-to-actions to render in your application (e.g. SELL, EDIT, DETAILS, P2P, PENDING_PAYOUT_INFO). The request body must contain a `tickets` array with at least one ticket. For each ticket, the response includes the sellability status (SELLABLE, NOT_SELLABLE, FOR_SALE, SOLD) and the URLs to redirect the user to complete the relevant flow.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","format":"email","description":"Email of the ticket owner/seller","example":"seller@example.com"},"tickets":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","description":"External event ID","example":"123"},"showId":{"type":"string","description":"Show ID","example":"456"},"ticketId":{"type":"string","description":"External ticket ID","example":"444"},"ticketOptionId":{"type":"string","description":"Ticket option ID","example":"789"},"priceTypeId":{"type":"string","description":"Price type ID (optional)","example":"101"}},"required":["eventId","showId","ticketId","ticketOptionId"]},"minItems":1,"description":"Array of tickets to evaluate."}},"required":["user","tickets"],"title":"Sell Access Layer Request (Tickets)","description":"Request body for evaluating sellability by ticket IDs.","examples":[{"user":"seller@example.com","tickets":[{"eventId":"123","showId":"456","ticketId":"TKT-ABC-123","ticketOptionId":"789"}]}]}}}},"responses":{"200":{"description":"Successfully evaluated the sell access layer and returned per-ticket results with CTAs","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP status code","example":200},"data":{"type":"object","properties":{"user":{"type":"string","description":"Email of the ticket owner/seller (echoed from the request)","example":"seller@example.com"},"tickets":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["SELLABLE","NOT_SELLABLE","FOR_SALE","SOLD"],"description":"Sellability status for the ticket","example":"SELLABLE"},"ticketId":{"type":"string","description":"External ticket ID from the request"},"ticketOptionId":{"type":"string","description":"Ticket option ID from the request"},"priceTypeId":{"type":"string","description":"Price type ID (if provided in the request)"},"sync":{"type":"boolean","description":"Whether the ticket exists in Menta DB (true) or not (false)","example":true},"callToActions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["SELL","DETAILS","PENDING_PAYOUT_INFO","P2P","EDIT","MANAGE"],"description":"Call-to-action identifier","example":"SELL"},"text":{"type":"string","description":"Display text for the call-to-action","example":"Sell"},"url":{"type":"string","description":"URL to navigate to when clicked","example":"https://sell-ticket.mentatickets.com/es/publish/..."},"enabled":{"type":"boolean","description":"Whether the CTA is enabled","example":true}},"required":["key","text","url","enabled"]},"description":"Available CTAs for this ticket based on its status"}},"required":["status","ticketId","ticketOptionId","sync","callToActions"]},"description":"Results for each ticket in the request"},"components":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"Component ID","example":"component123"},"type":{"type":"string","enum":["banner"],"description":"Component type (only banner is returned in sell responses)","example":"banner"},"class":{"type":"string","enum":["sellBanner"],"description":"Component class/style identifier","example":"sellBanner"},"sellBanner":{"type":"object","properties":{"title":{"type":"string","description":"Banner title","example":"Sell Your Tickets"},"description":{"type":"string","description":"Banner description","example":"List your tickets for sale"},"image":{"type":"string","description":"Banner image URL","example":"https://example.com/sell-banner.jpg"},"visible":{"type":"boolean","description":"Whether the banner is visible","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]}},"required":["title","description","image","visible","callToAction"]}},"required":["type","class"]},"description":"Sell access layer components associated with the request (only the sellBanner component is returned)."}},"required":["user","tickets","components"]}},"required":["status","data"],"title":"Sell Access Layer Response (Tickets)","description":"Response containing per-ticket sellability status and CTAs."}}}}}}},"/v1/wrapper/accesslayer (orders)":{"post":{"tags":["Smart Access Layer"],"summary":"Generate Sell Access Layer for OrderIds","description":"Evaluates the sellability of a user's orders and returns an aggregated status and call-to-actions per order (e.g. SELL, EDIT, DETAILS, MANAGE, PENDING_PAYOUT_INFO). The request body must contain an `orders` array with at least one order. Both endpoints use the same URL (`POST /v1/wrapper/accesslayer`) — the mode is determined by whether the body contains `tickets` or `orders`.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"string","format":"email","description":"Email of the ticket owner/seller","example":"seller@example.com"},"orders":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","description":"External order ID","example":"order-123"},"eventId":{"type":"string","description":"External event ID","example":"123"},"showId":{"type":"string","description":"Show ID","example":"456"},"combinations":{"type":"array","items":{"type":"object","properties":{"ticketOptionId":{"type":"string","description":"Ticket option ID","example":"789"},"priceTypeId":{"type":"string","description":"Price type ID (optional)","example":"101"}},"required":["ticketOptionId"]},"minItems":1,"description":"Array of ticketOption/priceType combinations that make up the order. Must contain at least one."}},"required":["orderId","eventId","showId","combinations"]},"minItems":1,"description":"Array of orders to evaluate."}},"required":["user","orders"],"title":"Sell Access Layer Request (Orders)","description":"Request body for evaluating sellability by order IDs.","examples":[{"user":"seller@example.com","orders":[{"orderId":"order-123","eventId":"123","showId":"456","combinations":[{"ticketOptionId":"789"}]}]}]}}}},"responses":{"200":{"description":"Successfully evaluated the sell access layer and returned per-order results with CTAs","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP status code","example":200},"data":{"type":"object","properties":{"user":{"type":"string","description":"Email of the ticket owner/seller (echoed from the request)","example":"seller@example.com"},"orders":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","description":"External order ID from the request"},"status":{"type":"string","enum":["SELLABLE","NOT_SELLABLE","FOR_SALE","SOLD"],"description":"Aggregated sellability status for the order","example":"SELLABLE"},"callToActions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["SELL","DETAILS","PENDING_PAYOUT_INFO","P2P","EDIT","MANAGE"],"description":"Call-to-action identifier","example":"SELL"},"text":{"type":"string","description":"Display text for the call-to-action","example":"Sell"},"url":{"type":"string","description":"URL to navigate to when clicked","example":"https://sell-ticket.mentatickets.com/es/publish/..."},"enabled":{"type":"boolean","description":"Whether the CTA is enabled","example":true}},"required":["key","text","url","enabled"]},"description":"Available CTAs for this order based on its aggregated status"}},"required":["orderId","status","callToActions"]},"description":"Results for each order in the request"},"components":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"Component ID","example":"component123"},"type":{"type":"string","enum":["banner"],"description":"Component type (only banner is returned in sell responses)","example":"banner"},"class":{"type":"string","enum":["sellBanner"],"description":"Component class/style identifier","example":"sellBanner"},"sellBanner":{"type":"object","properties":{"title":{"type":"string","description":"Banner title","example":"Sell Your Tickets"},"description":{"type":"string","description":"Banner description","example":"List your tickets for sale"},"image":{"type":"string","description":"Banner image URL","example":"https://example.com/sell-banner.jpg"},"visible":{"type":"boolean","description":"Whether the banner is visible","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]}},"required":["title","description","image","visible","callToAction"]}},"required":["type","class"]},"description":"Sell access layer components associated with the request (only the sellBanner component is returned)."}},"required":["user","orders","components"]}},"required":["status","data"],"title":"Sell Access Layer Response (Orders)","description":"Response containing per-order aggregated sellability status and CTAs."}}}}}}},"/v1/wrapper/accesslayer/bulk":{"post":{"tags":["Smart Access Layer"],"summary":"Get Smart Access Layer (Bulk)","description":"Retrieves smart access layer components for multiple events and shows in a single request. This endpoint is optimized for batch operations when you need to fetch components for multiple shows at once, reducing the number of API calls required. Each item in the request body must include an eventId and at least one showId. This endpoint only returns components of type button, modal, and banner.","parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","description":"External event ID","example":"123"},"showIds":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Array of show IDs. Must contain at least one show ID.","example":["456","789"]}},"required":["eventId","showIds"]},"minItems":1,"title":"Smart Access Layer Batch Request","description":"Array of event and show combinations to retrieve access layer components for. The array cannot be empty.","examples":[[{"eventId":"123","showIds":["456","789"]},{"eventId":"123","showIds":["456"]}],[{"eventId":"123","showIds":["456"]}]]}}}},"responses":{"200":{"description":"Successfully retrieved smart access layer components for all requested event and show combinations","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","description":"HTTP status code","example":200},"data":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","description":"External event ID","example":"123"},"showId":{"type":"string","description":"Show ID","example":"456"},"components":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"Component ID","example":"component123"},"type":{"type":"string","enum":["button","banner","modal"],"description":"Component type (only button, banner, and modal are returned in batch responses)","example":"button"},"class":{"type":"string","enum":["buyBanner","buyModal","buyButton"],"description":"Component class/style identifier","example":"buyButton"},"buyButton":{"type":"object","properties":{"visible":{"type":"boolean","description":"Whether the buy button is visible","example":true},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["visible","callToAction"]},"buyBanner":{"type":"object","properties":{"title":{"type":"string","description":"Banner title","example":"Buy Tickets Now"},"description":{"type":"string","description":"Banner description","example":"Get the best seats for this event"},"image":{"type":"string","description":"Banner image URL","example":"https://example.com/banner.jpg"},"visible":{"type":"boolean","description":"Whether the banner is visible","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]}},"required":["title","description","image","visible","callToAction"]},"buyModal":{"type":"object","properties":{"title":{"type":"string","description":"Modal title","example":"Purchase Tickets"},"description":{"type":"string","description":"Modal description","example":"Complete your purchase"},"image":{"type":"string","description":"Modal image URL","example":"https://example.com/modal.jpg"},"visible":{"type":"boolean","description":"Whether the modal is visible","example":true},"callToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text to display on the call-to-action element","example":"Buy Tickets"},"url":{"type":"string","description":"URL to navigate to when the call-to-action is clicked","example":"https://example.com/buy"},"enabled":{"type":"boolean","description":"Whether the call-to-action is enabled","example":true},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["text","url","enabled"]},"colors":{"type":"object","properties":{"background":{"type":"string","description":"Background color in hex format","example":"#FFFFFF"},"text":{"type":"string","description":"Text color in hex format","example":"#000000"}},"required":["background","text"]}},"required":["title","description","image","visible","callToAction"]}},"required":["type","class"]},"description":"Array of smart access layer components for this event and show combination (only button, modal, and banner types)"}},"required":["eventId","showId","components"]},"description":"Array of responses, each containing components for a specific event and show combination"}},"required":["status","data"],"title":"Smart Access Layer Batch Response","description":"Response containing status code and array of responses, each containing components for a specific event and show combination"}}}}}}},"/v1/marketdata/events/:externalReferenceId/inventory":{"put":{"tags":["Market Data"],"summary":"Update Event Inventory","description":"Updates inventory data for a complete event show. Use this endpoint to update capacity, released tickets, reserved space, sold out status, and sales percentage for an entire show. This provides market-level visibility into physical and real-time inventory capacity. If the event has multiple shows, you must specify showId as a query parameter; otherwise it is optional.","parameters":[{"name":"externalReferenceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"showId","in":"query","required":false,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"capacity":{"type":"number","example":500,"description":"The total capacity of the show"},"releasedTickets":{"type":"number","example":400,"description":"The number of released tickets for the show"},"reservedSpace":{"type":"number","example":100,"description":"The number of reserved space for the show. Reserved space is not for sale, but it is reserved for a specific purpose (future sales, unavailable seats, etc)."},"soldOut":{"type":"boolean","example":false,"description":"The boolean value indicating if the show is sold out"},"soldPercentage":{"type":"number","example":100,"description":"The percentage of sold tickets for the show"}},"description":"The inventory data for the show","example":{"capacity":500,"releasedTickets":400,"reservedSpace":100,"soldOut":false,"soldPercentage":100}}}}},"responses":{"200":{"description":"Successfully updated event inventory","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"The boolean value indicating if the inventory was updated successfully"}},"required":["success"],"description":"The response from the inventory update endpoint","example":{"success":true}}}}}}}},"/v1/marketdata/events/:externalReferenceId/inventory/details":{"put":{"tags":["Market Data"],"summary":"Update Event Inventory Details","description":"Updates inventory details for a complete event show. Use this endpoint to update capacity, released tickets, reserved space, sold out status, and sales percentage for an entire show. This provides market-level visibility into physical and real-time inventory capacity.","parameters":[{"name":"externalReferenceId","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"showId":{"type":"string","example":"456","description":"The ID of the show in your system."},"ticketOptionId":{"type":"string","example":"789","description":"The ID of the ticket option in your system."},"priceTypeId":{"type":"string","example":"101","description":"The ID of the price type in your system."},"inventory":{"type":"object","properties":{"releasedTickets":{"type":"number","example":100,"description":"The number of released tickets for the ticket option"},"reservedSpace":{"type":"number","example":100,"description":"The number of reserved space for the ticket option"},"soldOut":{"type":"boolean","example":false,"description":"The boolean value indicating if the ticket option is sold out"},"soldPercentage":{"type":"number","example":100,"description":"The percentage of sold tickets for the ticket option"}},"description":"The inventory data for the ticket option, price type or the combination of both","example":{"releasedTickets":100,"reservedSpace":100,"soldOut":false,"soldPercentage":100}}},"required":["showId","inventory"]}}},"required":["items"],"description":"The inventory details for the show","examples":[{"items":[{"showId":"123","ticketOptionId":"123","priceTypeId":"123","inventory":{"releasedTickets":100,"reservedSpace":100,"soldOut":false,"soldPercentage":95}}]},{"items":[{"showId":"123","ticketOptionId":"123","inventory":{"releasedTickets":100,"reservedSpace":100,"soldOut":true,"soldPercentage":100}}]}]}}}},"responses":{"200":{"description":"Successfully updated event inventory details","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"The boolean value indicating if the inventory details were updated successfully"}},"required":["success"]}}}}}}},"/v1/marketdata/users (Ticket Holder)":{"post":{"tags":["Market Data"],"summary":"Create Ticket Holder Lead","description":"Creates a Ticket Holder lead for a specific event show. A Ticket Holder is a user who has completed a purchase in primary sales and owns a valid ticket. These leads help menta identify potential resellers in the secondary market. The buyer object must include at least one identifier (email, phone, or id). Fields ticketId and price are required for this lead type. The system uses upsert logic: if a lead with the same buyer identifier, externalReferenceEventId, and showId already exists, it will be updated instead of duplicated.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","const":"TICKET_HOLDER","description":"The type of ticket lead. Must be \"TICKET_HOLDER\" for users who have completed a purchase and own a valid ticket.","example":"TICKET_HOLDER"},"externalReferenceEventId":{"type":"string","description":"The external reference ID of the event in your system.","example":"evt_2024_metallica"},"showId":{"type":"string","description":"The ID of the show in your system.","example":"show_nyc_20240815"},"ticketId":{"type":"string","description":"The unique identifier of the ticket in your system. Required for confirmed purchases.","example":"TICKET_abc123def456"},"buyer":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the buyer. At least one identifier (email, phone, or id) is required.","example":"john.doe@example.com"},"phone":{"type":"string","description":"Phone number of the buyer.","example":"+1234567890"},"fullName":{"type":"string","description":"Full name of the buyer.","example":"John Doe"},"id":{"type":"string","description":"Unique identifier of the user in your system. Recommended for GDPR/LGPD compliance when email or phone may change.","example":"user_12345"}},"description":"Buyer information. At least one identifier (email, phone, or id) is required to identify the buyer."},"price":{"type":"number","exclusiveMinimum":0,"description":"Price paid for the ticket. Required for confirmed purchases. Must be a positive number.","example":99.99},"currency":{"type":"string","description":"Currency code in ISO 4217 format.","example":"USD"},"ticketOptionId":{"type":"string","description":"The ID of the ticket option/category in your system (e.g., GA, VIP, ga_t198).","example":"GA"},"priceTypeId":{"type":"string","description":"The ID of the price type in your system (e.g., early_bird, regular, rg_price_19370).","example":"regular"},"date":{"type":"string","description":"Date of the purchase in ISO 8601 format.","example":"2024-12-15T10:30:00Z"},"seating":{"type":"object","properties":{"section":{"type":"string","description":"Section of the seat.","example":"A"},"row":{"type":"string","description":"Row of the seat.","example":"5"},"seat":{"type":"string","description":"Seat number.","example":"12"}},"description":"Seat information for the ticket."},"metadata":{"type":"object","additionalProperties":{},"description":"Custom metadata as key-value pairs for additional context.","example":{"section_type":"vip","notes":"Premium seating"}},"tags":{"type":"array","items":{"type":"string"},"description":"Array of string tags for categorization and reporting.","example":["vip","early_bird"]},"attributes":{"type":"array","items":{"type":"string","enum":["OBSTRUCTED_VIEW","PARTIAL_VIEW","RESTRICTED_VIEW","SIDE_VIEW","WHEELCHAIR_ACCESS","COMPANION_SEAT","REMOVABLE_ARMREST","LEVEL_ACCESS","AISLE_SEAT","EXTRA_LEGROOM","HIGH_STOOL","RESTRICTED_LEGROOM"]},"description":"The attributes of the ticket.","example":["EXTRA_LEGROOM"]}},"required":["type","externalReferenceEventId","showId","ticketId","buyer","price"],"description":"Ticket Holder lead request body. A Ticket Holder is a user who has completed a purchase and owns a valid ticket. These leads help identify potential resellers in the secondary market.","example":{"type":"TICKET_HOLDER","externalReferenceEventId":"evt_2024_metallica","showId":"show_nyc_20240815","ticketId":"TICKET_abc123def456","buyer":{"email":"john.doe@example.com","fullName":"John Doe","id":"user_12345"},"price":99.99,"currency":"USD","ticketOptionId":"GA","priceTypeId":"regular","date":"2024-12-15T10:30:00Z","seating":{"section":"A","row":"5","seat":"12"},"metadata":{"section_type":"vip","notes":"Premium seating"},"tags":["vip","early_bird"],"attributes":["EXTRA_LEGROOM"]}}}}},"responses":{"200":{"description":"Ticket Holder lead successfully created or updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Indicates if the ticket lead was created or updated successfully."}},"required":["success"]}}}}}}},"/v1/marketdata/users (Abandoned Cart)":{"post":{"tags":["Market Data"],"summary":"Create Abandoned Cart Lead","description":"Creates an Abandoned Cart lead for a specific event show. An Abandoned Cart lead represents a user who initiated the purchase process in primary sales but did not complete the transaction. These users are potential buyers in the secondary market when price or availability changes. The buyer object must include at least one identifier (email, phone, or id). The system uses upsert logic: if a lead with the same buyer identifier, externalReferenceEventId, and showId already exists, it will be updated instead of duplicated.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","const":"ABANDONED_CART","description":"The type of ticket lead. Must be \"ABANDONED_CART\" for users who initiated the purchase process but did not complete the transaction.","example":"ABANDONED_CART"},"externalReferenceEventId":{"type":"string","description":"The external reference ID of the event in your system.","example":"evt_2024_metallica"},"showId":{"type":"string","description":"The ID of the show in your system.","example":"show_nyc_20240815"},"ticketId":{"type":"string","description":"The unique identifier of the ticket in your system. Optional for abandoned carts, as the user may not have selected a specific ticket.","example":"TICKET_def456ghi789"},"buyer":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the buyer. At least one identifier (email, phone, or id) is required.","example":"potential@example.com"},"phone":{"type":"string","description":"Phone number of the buyer.","example":"+1234567890"},"fullName":{"type":"string","description":"Full name of the buyer.","example":"Jane Smith"},"id":{"type":"string","description":"Unique identifier of the user in your system. Recommended for GDPR/LGPD compliance when email or phone may change.","example":"user_abandoned_1"}},"description":"Buyer information. At least one identifier (email, phone, or id) is required to identify the buyer."},"ticketOptionId":{"type":"string","description":"The ID of the ticket option/category of interest in your system (e.g., GA, VIP).","example":"VIP"},"priceTypeId":{"type":"string","description":"The ID of the price type in your system (e.g., early_bird, regular).","example":"early_bird"},"date":{"type":"string","description":"Date when the user has abandoned the cart in ISO 8601 format.","example":"2024-12-14T15:45:00Z"},"price":{"type":"number","description":"Price of the ticket that was in the cart. Optional, as the user may not have reached the pricing step.","example":149.99},"currency":{"type":"string","description":"Currency code in ISO 4217 format.","example":"USD"},"seating":{"type":"object","properties":{"section":{"type":"string","description":"Section of the seat.","example":"B"},"row":{"type":"string","description":"Row of the seat.","example":"10"},"seat":{"type":"string","description":"Seat number.","example":"5"}},"description":"Seat information for the ticket that was in the cart."},"metadata":{"type":"object","additionalProperties":{},"description":"Custom metadata as key-value pairs for additional context.","example":{"last_action":"checkout","items_in_cart":2,"reason_abandoned":"payment_failed"}},"tags":{"type":"array","items":{"type":"string"},"description":"Array of string tags for categorization and reporting.","example":["abandoned","recovery_email_sent"]}},"required":["type","externalReferenceEventId","showId","buyer"],"description":"Abandoned Cart lead request body. An Abandoned Cart lead represents a user who initiated the purchase process in primary sales but did not complete the transaction. These users are potential buyers in the secondary market when price or availability changes.","example":{"type":"ABANDONED_CART","externalReferenceEventId":"evt_2024_metallica","showId":"show_nyc_20240815","ticketId":"TICKET_def456ghi789","buyer":{"email":"potential@example.com","id":"user_abandoned_1","fullName":"Jane Smith"},"ticketOptionId":"VIP","priceTypeId":"early_bird","date":"2024-12-14T15:45:00Z","price":149.99,"currency":"USD","seating":{"section":"B","row":"10"},"metadata":{"last_action":"checkout","items_in_cart":2,"reason_abandoned":"payment_failed"},"tags":["abandoned","recovery_email_sent"]}}}}},"responses":{"200":{"description":"Abandoned Cart lead successfully created or updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Indicates if the ticket lead was created or updated successfully."}},"required":["success"]}}}}}}},"/v1/marketdata/users (Virtual Queue)":{"post":{"tags":["Market Data"],"summary":"Create Virtual Queue Lead","description":"Creates a Virtual Queue lead for a specific event show. A Virtual Queue lead represents a user who was in the virtual queue to purchase tickets but abandoned the process without completing a purchase. These users demonstrated real-time interest in the event and are potential buyers in the secondary market. The buyer object must include at least one identifier (email, phone, or id). The system uses upsert logic: if a lead with the same buyer identifier, externalReferenceEventId, and showId already exists, it will be updated instead of duplicated.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","const":"VIRTUAL_QUEUE","description":"The type of ticket lead. Must be \"VIRTUAL_QUEUE\" for users who were in the virtual queue to purchase tickets but abandoned the process without completing a purchase.","example":"VIRTUAL_QUEUE"},"externalReferenceEventId":{"type":"string","description":"The external reference ID of the event in your system.","example":"evt_2024_metallica"},"showId":{"type":"string","description":"The ID of the show in your system.","example":"show_nyc_20240815"},"buyer":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the buyer. At least one identifier (email, phone, or id) is required.","example":"queue@example.com"},"phone":{"type":"string","description":"Phone number of the buyer.","example":"+1987654321"},"fullName":{"type":"string","description":"Full name of the buyer.","example":"Robert Wilson"},"id":{"type":"string","description":"Unique identifier of the user in your system. Recommended for GDPR/LGPD compliance when email or phone may change.","example":"user_queue_1"}},"description":"Buyer information. At least one identifier (email, phone, or id) is required to identify the buyer."},"ticketOptionId":{"type":"string","description":"The ID of the ticket option/category the user was queued for in your system (e.g., GA, VIP, ga_t198).","example":"GA"},"priceTypeId":{"type":"string","description":"The ID of the price type the user was queued for in your system (e.g., early_bird, regular, rg_price_19370).","example":"regular"},"date":{"type":"string","description":"Date when the user was in the virtual queue in ISO 8601 format.","example":"2024-12-14T09:15:00Z"},"price":{"type":"number","description":"Price of the ticket the user was attempting to purchase.","example":99.99},"currency":{"type":"string","description":"Currency code in ISO 4217 format.","example":"USD"},"metadata":{"type":"object","additionalProperties":{},"description":"Custom metadata as key-value pairs for additional context.","example":{"queue_position":2500,"wait_time_minutes":45,"queue_exit_reason":"timeout"}},"tags":{"type":"array","items":{"type":"string"},"description":"Array of string tags for categorization and reporting.","example":["queue_abandonment","high_demand"]}},"required":["type","externalReferenceEventId","showId","buyer"],"description":"Virtual Queue lead request body. A Virtual Queue lead represents a user who was in the virtual queue to purchase tickets but abandoned the process without completing a purchase. These users demonstrated real-time interest and are potential buyers in the secondary market.","example":{"type":"VIRTUAL_QUEUE","externalReferenceEventId":"evt_2024_metallica","showId":"show_nyc_20240815","buyer":{"email":"queue@example.com","id":"user_queue_1"},"ticketOptionId":"GA","metadata":{"queue_position":2500,"wait_time_minutes":45,"queue_exit_reason":"timeout"},"tags":["queue_abandonment","high_demand"]}}}}},"responses":{"200":{"description":"Virtual Queue lead successfully created or updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Indicates if the ticket lead was created or updated successfully."}},"required":["success"]}}}}}}},"/v1/marketdata/users (Wishlist)":{"post":{"tags":["Market Data"],"summary":"Create Wishlist Lead","description":"Creates a Wishlist lead for a specific event show. A Wishlist lead represents a user who explicitly subscribed to receive availability notifications for tickets. This is the highest quality lead type due to the direct opt-in, showing high probability of conversion. The buyer object must include at least one identifier (email, phone, or id). The system uses upsert logic: if a lead with the same buyer identifier, externalReferenceEventId, and showId already exists, it will be updated instead of duplicated.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","const":"WISHLIST","description":"The type of ticket lead. Must be \"WISHLIST\" for users who subscribed to availability notifications.","example":"WISHLIST"},"externalReferenceEventId":{"type":"string","description":"The external reference ID of the event in your system.","example":"evt_2024_metallica"},"showId":{"type":"string","description":"The ID of the show in your system.","example":"show_nyc_20240815"},"ticketId":{"type":"string","description":"The unique identifier of the ticket in your system. Optional for wishlist leads.","example":"TICKET_mno345pqr678"},"buyer":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the buyer. At least one identifier (email, phone, or id) is required.","example":"wishlist@example.com"},"phone":{"type":"string","description":"Phone number of the buyer.","example":"+1234567890"},"fullName":{"type":"string","description":"Full name of the buyer.","example":"Michael Brown"},"id":{"type":"string","description":"Unique identifier of the user in your system. Recommended for GDPR/LGPD compliance when email or phone may change.","example":"user_wishlist_1"}},"description":"Buyer information. At least one identifier (email, phone, or id) is required to identify the buyer."},"ticketOptionId":{"type":"string","description":"The ID of the ticket option/category the user was added to the wishlist for in your system (e.g., GA, VIP, ga_t198).","example":"VIP"},"priceTypeId":{"type":"string","description":"The ID of the price type the user was added to the wishlist for in your system (e.g., early_bird, regular, rg_price_19370).","example":"price_level_1"},"date":{"type":"string","description":"Date when the user was added to the wishlist in ISO 8601 format.","example":"2024-12-10T14:20:00Z"},"price":{"type":"number","description":"Reference price or maximum price the user is willing to pay.","example":199.99},"currency":{"type":"string","description":"Currency code in ISO 4217 format.","example":"USD"},"metadata":{"type":"object","additionalProperties":{},"description":"Custom metadata as key-value pairs for additional context.","example":{"notification_frequency":"daily","preferred_section":"floor","max_price_willing_to_pay":250}}},"required":["type","externalReferenceEventId","showId","buyer"],"description":"Wishlist lead request body. A Wishlist lead represents a user who explicitly subscribed to receive availability notifications. This is the highest quality lead type due to the direct opt-in and shows high probability of conversion.","example":{"type":"WISHLIST","externalReferenceEventId":"evt_2024_metallica","showId":"show_nyc_20240815","buyer":{"email":"wishlist@example.com","id":"user_wishlist_1","fullName":"Michael Brown"},"ticketOptionId":"VIP","priceTypeId":"price_level_1","date":"2024-12-10T14:20:00Z","price":199.99,"currency":"USD"}}}}},"responses":{"200":{"description":"Wishlist lead successfully created or updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Indicates if the ticket lead was created or updated successfully."}},"required":["success"]}}}}}}},"/v1/marketdata/users/bulk":{"post":{"tags":["Market Data"],"summary":"Create Ticket Leads (Bulk)","description":"Creates multiple ticket leads in a single request. You can mix different lead types (TICKET_HOLDER, ABANDONED_CART, VIRTUAL_QUEUE, WISHLIST) in the same request. Maximum of 1000 leads per request. Each lead is validated individually. The system uses upsert logic based on the buyer identifier (email, phone, or id) combined with externalReferenceEventId and showId, so sending the same lead multiple times will not create duplicates.","parameters":[{"in":"header","name":"Authorization","description":"Your menta tech private API Key provided by your account manager.","schema":{"type":"string","description":"Your menta tech private API Key provided by your account manager.","example":"09deff-2341-ade92341-7090-ff11"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["TICKET_HOLDER","ABANDONED_CART","VIRTUAL_QUEUE","WISHLIST"],"description":"The type of ticket lead. Determines the purpose and required fields for this lead.","example":"TICKET_HOLDER"},"externalReferenceEventId":{"type":"string","description":"The external reference ID of the event in your system.","example":"evt_2024_metallica"},"showId":{"type":"string","description":"The ID of the show in your system.","example":"show_nyc_20240815"},"ticketId":{"type":"string","description":"The unique identifier of the ticket in your system. Required for TICKET_HOLDER, optional for other types.","example":"TICKET_abc123"},"buyer":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the buyer. At least one identifier (email, phone, or id) is required.","example":"buyer1@example.com"},"phone":{"type":"string","description":"Phone number of the buyer.","example":"+1234567890"},"fullName":{"type":"string","description":"Full name of the buyer.","example":"John Doe"},"id":{"type":"string","description":"Unique identifier of the user in your system. Recommended for GDPR/LGPD compliance when email or phone may change.","example":"user_12345"}},"description":"Buyer information. At least one identifier (email, phone, or id) is required to identify the buyer."},"price":{"type":"number","description":"Price of the ticket. Required for TICKET_HOLDER, optional for other types.","example":99.99},"currency":{"type":"string","description":"Currency code in ISO 4217 format.","example":"USD"},"ticketOptionId":{"type":"string","description":"The ID of the ticket option/category in your system (e.g., GA, VIP).","example":"GA"},"priceTypeId":{"type":"string","description":"The ID of the price type in your system (e.g., early_bird, regular).","example":"regular"},"purchaseDate":{"type":"string","description":"Relevant date in ISO 8601 format. For TICKET_HOLDER: purchase date. For ABANDONED_CART: cart abandonment date. For VIRTUAL_QUEUE: queue exit date. For WISHLIST: subscription date.","example":"2024-12-15T10:30:00Z"},"seating":{"type":"object","properties":{"section":{"type":"string","description":"Section of the seat.","example":"A"},"row":{"type":"string","description":"Row of the seat.","example":"5"},"seat":{"type":"string","description":"Seat number.","example":"12"}},"description":"Seat information for the ticket."},"metadata":{"type":"object","additionalProperties":{},"description":"Custom metadata as key-value pairs for additional context.","example":{"source":"website_checkout"}},"tags":{"type":"array","items":{"type":"string"},"description":"Array of string tags for categorization and reporting.","example":["vip","early_bird"]}},"required":["type","externalReferenceEventId","showId","buyer"]},"description":"Array of ticket leads to create in bulk. You can mix different lead types (TICKET_HOLDER, ABANDONED_CART, VIRTUAL_QUEUE, WISHLIST) in the same request. Maximum 1000 leads per request.","example":[{"type":"TICKET_HOLDER","externalReferenceEventId":"evt_2024_metallica","showId":"show_nyc_20240815","ticketId":"TICKET_abc123","buyer":{"email":"buyer1@example.com","fullName":"John Doe"},"price":99.99,"currency":"USD"},{"type":"TICKET_HOLDER","externalReferenceEventId":"evt_2024_metallica","showId":"show_nyc_20240815","ticketId":"tkt_091bad9f1d83a","buyer":{"id":"usr_9289370133"},"price":451.31,"currency":"MXN"},{"type":"ABANDONED_CART","externalReferenceEventId":"evt_2024_metallica","showId":"show_nyc_20240815","buyer":{"email":"abandoned@example.com"},"ticketOptionId":"GA"},{"type":"WISHLIST","externalReferenceEventId":"evt_2024_metallica","showId":"show_nyc_20240815","buyer":{"email":"wishlist@example.com","id":"user_wishlist_1"},"ticketOptionId":"VIP"}]}}}},"responses":{"200":{"description":"Ticket leads successfully created or updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Indicates if the ticket leads were created or updated successfully."}},"required":["success"]}}}}}}}}}