DescriptionTOP

Privileges required: campaign:write

Create a new event using a properly formatted JSON request payload, as shown in the Example JSON Request Body.

DescriptionTOP

Privileges required: mylibrary:folder:create

Create a new MyLibrary folder by providing the name of the folder and the id of the parent folder if the new folder is to be a child folder (nested in another folder) in the JSON request body. See the example JSON request in the following sections.

DescriptionTOP

Privileges required: campaign:write

Create a new item for an event specified using the eventId path parameter. To create an item, include the following items in the JSON request body:

• name - each item for an event must have a unique name, with mininum length of 1 character
• price - if an item is available at no cost to registrants and guest, set = 0.00
• default_quantity_total - starting quantity of this item available to registrants and guests
• per_registrant_limit - maximum quantity available to each registrant or guest
• show_quantity_available - use this setting to display, or not, the remaining quantity available on the registration page.

Optionally you can include a description of the item in the request body as well.

After you create an item, you can then add attributes to it, such as sizes, colors, just to name a few, using the Item Attribute Collection endpoint.

DescriptionTOP

Privileges required: campaign:write

Create a promotional code for an existing event (specified using eventId). Promotional codes can be:

• a percentage discount off a fee or set of fees
• a fixed discount amount off a fee
• a special promotional fee available by entering the promo code

DescriptionTOP

Privileges required: campaign:write

Create a new fee for the event specified using the eventId path parameter. 

DescriptionTOP

Privileges required: campaign:write

Create a new attribute for an event item; specify the event and item using the eventId and itemId path parameters. To create an attribute, include the attribute name and quantity_total (minimum = 0) in the JSON request body. Each attribute for an item must have a unique name with a minimum length of 1 character.

DescriptionTOP

Privileges required: campaign:activate

Schedule an email campaign specified by the campaignId path parameter to run and be sent out. Define the date and time that the email campaign will be submitted to the send queue (in ISO 8601 format) using the scheduled_date property. You can create a schedule only for an email campaign in DRAFT or SENT status.

When scheduling a campaign, please provide a lead time of at least 20 minutes; otherwise, you may receive an invalid schedule error response.

NOTE: The account must be in good standing to be able to schedule and send an email campaign. 

Sending a Campaign "Now"

To send a campaign "now", only include {} in the JSON request payload. When using the Send Now function, the response body will show the time that the scheduling request was made, not the time the email campaign will be sent. Send Now puts the campaign into the queue for the next send window, which occur on a regular basis, generally every 5 minutes.

Resending a Campaign

You can resend an existing campaign that has a SENT status using this endpoint. The campaign will only be sent to contacts that have been added to the contact lists since the last time the campaign was sent (based on the last_run_date value)

DescriptionTOP

Privileges required: campaign:create

When creating a new email campaign, template_type is automatically set to CUSTOM; There are several campaign properties that are optional by default, but become REQUIRED once another property is used. See Structure table below for specific properties.

Example JSON Request BodyTOP

{
    "name": "Golf Shirt w/logo",
    "description":"Underarmour moisture wicking material",
    "price":32.0,
    "per_registrant_limit": 2,
    "show_quantity_available": false,
    "default_quantity_total": 300
}

Response CodesTOP

StructureTOP

Example ResponseTOP

{
    "id":"9k7uXp6Hgyiq7BCC11zFc7IwqpZ7nzW2Y09fUs00t3Q",
    "name":"Golf Shirt w/logo",
    "description":"Underarmour moisture wicking material",
    "price":32.0,
    "attributes":[
    ],
    "per_registrant_limit":2,
    "show_quantity_available":false,
    "default_quantity_total":300,
    "default_quantity_available":300
}