Partners API
Cymbal provides multiple REST API endpoints for uploading an organization's events, orders, and contacts.
Last updated
Cymbal provides multiple REST API endpoints for uploading an organization's events, orders, and contacts.
Last updated
The Cymbal Partners API requires an API token for authentication. This API token must be created within the Cymbal manager for a given organization.
Create an organization in the manager: https://manager.cymbal.co
Generate an API token for the given partner: https://manager.cymbal.co/settings/integrations
Pass the API token in the Cymbal-Partner-API-Key
header in every API request.
API tokens can be revoked by an organization within the manager. If API requests return a 403
status code, you will need to generate a new API token.
POST
https://api.cymbal.co/v1/partners/events
Create a set of events for an organization.
Name | Type | Description |
---|---|---|
Required Fields:
id
url
name
image_url
start_datetime
location
Notes:
status options: live
| canceled
datetime format: 2024-03-02T15:30:00Z
in UTC
POST
https://api.cymbal.co/v1/partners/orders
Create a set of orders for a given organization.
Required Fields:
id
event_id
customer
marketing_opt_ins
items
Notes:
customer fields: only one of phone
or email
is required
item fields: currency_code
is optional. USD
is the default
address
can just be a zip code.
POST
https://api.cymbal.co/v1/partners/subscribe
Subscribe a given contact to either email or SMS communication.
Required fields:
one of phone
and/or email
is required; all other fields are optional
Notes:
customer fields: only one of phone
or email
is required
tags
must be created within the Cymbal manager first
genres
must match one of Cymbal's required list of genres: Genres
ticket_url
is optional and is used for subscribe forms that are embedded on an event page
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Cymbal-Partner-API-Key*
String
Organization's provided API key
events*
[Event]
List of events.
Cymbal-Partner-API-Key*
String
Organization's provided API key
orders*
[Order]
List of orders.
Cymbal-Partner-API-Key*
String
Organization's provided API key
contact*
Contact
Contact information.