Our v3 API is now available! Learn more by visiting the v3 developer portal.

Individual Event Item Endpoint

Use Event Items to make products associated with an event available to registrants and their guests (if applicable) for purchase or at no cost, on the event registration page. Use this API endpoint to retrieve (GET), update (PUT), and DELETE a specific event item.

Methods:

Click a method to view its documentation

GET PUT DELETE

DescriptionTOP

Privileges required: campaign:write

Update an existing event item; specify the event and the item using the eventId and itemId path parameters.

PUT: https://api.constantcontact.com/v2/eventspot/events/{eventId}/items/{itemId}

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

eventId

path

Unique ID of the event for which you are updating the item

itemId

path

Unique ID of the item to update

Example JSON Request BodyTOP

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

Response CodesTOP

code

description

200

The item was successfully updated

400

Either JSON was malformed or there was a data validation error

401

Authentication failure

404

An event or item with specified ID not found

406

Unsupported accept header value, must be application/json

415

Unsupported content-type in the header, must be application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

+ attributes

array

An array of item attributes and options (Read Only)

default_quantity_available

integer

Number of items available for sale, displayed on the registration page if show_quantity_available = true. (Read Only)

default_quantity_total

integer

REQUIRED. The total quantity of items offered for sale, minimum = 0, cannot leave blank. If the item has attributes, the summation of the quantity_total for all attributes automatically overwrites the value you enter here.

description

string (2048)

The item description that is shown on the registration page

id

string (100)

The items unique ID (Read Only)

name

string (100)

REQUIRED. Item name that is shown on the registration page

per_registrant_limit

integer

REQUIRED. The maximum quantity of this item that a registrant, as well as any of their guests, can purchase, minimum = 0, cannot leave blank; value cannot be greater than the value of default_quantity_available

price

number

REQUIRED. The item cost, minimum = 0.00

show_quantity_available

boolean

If true, displays the remaining quantity of this item for purchase on the registration page

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":true,
    "default_quantity_total":300,
    "default_quantity_available":300
}