Update an event

put

https://{hostname}/events/v3/events/{eventId}

Updates the specified event.

Path Params

eventId

integer

required

The identifier of the event.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Contains information about the request body parameters that you can specify when updating an event. It also includes tags and objects that you can associate with an event.

audienceLocations

array of strings

length ≤ 20

Two-letter ISO 3166 country codes that indicate geographic areas of audiences. This array can contain up to 20 unique items.

audienceLocations

audienceSize

integer

The audience's size for the event. The minimum value is 1.

coordinators

array of strings

length ≤ 20

Up to 20 Control Center usernames of those who serve as the event's coordinators.

coordinators

customerEventId

string

The user-specified ID for the event. This ID can be up to 100 characters long. Customer Event ID.

description

string

The description of the event. This description can be up to 2000 characters long.

end

date-time

required

An ISO 8601 timestamp indicating the end date of the event.

name

string

required

length between 1 and 750

The name of the event. This name can be up to 750 characters long.

objects

array of objects

Objects associated with the event. This array can include only unique items.

objects

start

date-time

required

An ISO 8601 timestamp indicating the start date of the event.

200Successful response.

400Bad request. Invalid request. Details may be available in the response body.

403Forbidden. Insufficient permissions to access event or associated objects.

404Not found. The requested event wasn't found.

409Conflict. The event was modified after you retrieved it. Please refetch the event, reconcile possible differences and resubmit the request.