Sign in
Basic

Create or update a marketing event

Upserts a marketing event If there is an existing marketing event with the specified ID, it will be updated; otherwise a new event will be created.

put/marketing/v3/marketing-events/events/{externalEventId}

Path parameters

externalEventIdstring required

The id of the marketing event in the external event application

Request body

endDateTimestring date-time

The end date and time of the marketing event.

eventCancelledboolean

Indicates if the marketing event has been cancelled. Defaults to false

eventCompletedboolean

Indicates if the marketing event has been completed. Defaults to false

eventDescriptionstring

The description of the marketing event.

eventNamestring required

The name of the marketing event.

eventOrganizerstring required

The name of the organizer of the marketing event.

eventTypestring

Describes what type of event this is. For example: WEBINAR, CONFERENCE, WORKSHOP

eventUrlstring

A URL in the external event application where the marketing event can be managed.

externalAccountIdstring required

The accountId that is associated with this marketing event in the external event application.

externalEventIdstring required

The id of the marketing event in the external event application.

startDateTimestring date-time

The start date and time of the marketing event.

Response

successful operation

createdAtstring date-time required

The creation date and time of the marketing event.

endDateTimestring date-time

The end date and time of the marketing event.

eventCancelledboolean

Indicates if the marketing event has been cancelled.

eventCompletedboolean

Indicates if the marketing event has been completed.

eventDescriptionstring

The description of the marketing event.

eventNamestring required

The name of the marketing event.

eventOrganizerstring required

The name of the organizer of the marketing event.

eventTypestring

The type of the marketing event.

eventUrlstring

A URL in the external event application where the marketing event can be managed.

idstring required

The ID of the marketing event CRM object.

objectIdstring

The ID of the marketing event CRM object.

startDateTimestring date-time

The start date and time of the marketing event.

updatedAtstring date-time required

The update date and time of the marketing event.