(v1) Import Event Data

post

https://{amsServer}/{amsAppName}/api/v1/eventimport

Creates new events or updates existing events.

To update an existing event, provide its ID in existingEventId. To create a new event, omit existingEventId or leave it empty.

The rows array supports multi-row entry for forms that allow multiple rows per event.

Field key values must exactly match the field names as configured in AMS (use GET /api/v3/forms/{form_type}/{form_id} to retrieve exact field names).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

informat

string

enum

required

Allowed:

format

string

enum

required

Allowed:

Body Params

formName

string

required

Exact form name as it appears in AMS

startDate

string

required

Event start date in dd/MM/yyyy format

finishDate

string

required

Event finish date in dd/MM/yyyy format

startTime

string

required

Event start time in h:mm AM/PM format (e.g. 9:00 AM)

finishTime

string

Event finish time in h:mm AM/PM format. If omitted, defaults to one hour after startTime.

userId

object

required

enteredByUserId

integer

The user ID to set as the 'entered by' user. Defaults to the authenticated account.

existingEventId

string

The ID of an existing event to update. Omit to create a new event.

rows

array of objects

required

rows*

Headers

X-APP-ID

string

A unique identifier for your application. Helps Teamworks support staff identify your requests if you need assistance.

Response

200

Event created or updated successfully