Create or Update a Timeline Event

PUT /integrations/v1/:application‐id/timeline/event

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Create a new event, or update an existing event.

Please see the Timeline Overview for more details about creating events.

Required Parameters How to use Description
OAuth Access Token Authorization: Bearer {token} header

Used to authenticate the request. Please see this page for more details about authentication.
NOTE: You must use an OAuth access token to create an event. API keys are not supported.

application-id Used in the request URL The ID of the application that the event type was created for.  The eventTypeId used in the request body must line up with this application-id.
 id Used in the request body

The ID of the event you're creating.  You will need to specify your own event ID when creating an ID, it will not be assigned automatically.

Using the ID of an existing event will update the existing event.

 eventTypeId Used in the request body The event type that you're creating. This must line up with the application-id in the request URL.
     

Optional Parameters How to use Description
objetId Used in the request body The vid of the contact you're adding the event to.
email Used in the request body The email of the contact you're adding the event to.
utk Used in the request body The usertoken of the contact you're adding the event to.

See the JSON examples for more details for including custom properties or extra data.

Returns a 204 response on success. Otherwise, you'll receive a 4xx error, with more details about the specific error in the body of the response.