Bulk Create Events

POST {{baseUrl}}/api/event-bulk-create-jobs/

Create a batch of events for one or more profiles.

Note that this endpoint allows you to create new profiles or update existing profile properties.

At a minimum, profile and metric objects should include at least one profile identifier (e.g., id, email, or phone_number) and the metric name, respectively.

Accepts up to 1,000 events per request. The maximum allowed payload size is 5MB.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes: events:write

Request Body

{"data"=>{"type"=>"event-bulk-create-job", "attributes"=>{"events-bulk-create"=>{"data"=>[{"type"=>"event-bulk-create", "attributes"=>{"profile"=>{"data"=>{"type"=>"profile", "attributes"=>{"email"=>"<string>", "phone_number"=>"<string>", "external_id"=>"<string>", "anonymous_id"=>"<string>", "_kx"=>"<string>", "first_name"=>"<string>", "last_name"=>"<string>", "organization"=>"<string>", "title"=>"<string>", "image"=>"<string>", "location"=>{"address1"=>"<string>", "address2"=>"<string>", "city"=>"<string>", "country"=>"<string>", "latitude"=>"<string>", "longitude"=>"<string>", "region"=>"<string>", "zip"=>"<string>", "timezone"=>"<string>", "ip"=>"<string>"}}, "id"=>"<string>", "meta"=>{"patch_properties"=>{"unset"=>"<string>"}}}}, "events"=>{"data"=>[{"type"=>"event", "attributes"=>{"metric"=>{"data"=>{"type"=>"metric", "attributes"=>{"name"=>"<string>", "service"=>"<string>"}}}, "time"=>"<dateTime>", "value"=>"<number>", "value_currency"=>"<string>", "unique_id"=>"<string>"}}, {"type"=>"event", "attributes"=>{"metric"=>{"data"=>{"type"=>"metric", "attributes"=>{"name"=>"<string>", "service"=>"<string>"}}}, "time"=>"<dateTime>", "value"=>"<number>", "value_currency"=>"<string>", "unique_id"=>"<string>"}}]}}}, {"type"=>"event-bulk-create", "attributes"=>{"profile"=>{"data"=>{"type"=>"profile", "attributes"=>{"email"=>"<string>", "phone_number"=>"<string>", "external_id"=>"<string>", "anonymous_id"=>"<string>", "_kx"=>"<string>", "first_name"=>"<string>", "last_name"=>"<string>", "organization"=>"<string>", "title"=>"<string>", "image"=>"<string>", "location"=>{"address1"=>"<string>", "address2"=>"<string>", "city"=>"<string>", "country"=>"<string>", "latitude"=>"<string>", "longitude"=>"<string>", "region"=>"<string>", "zip"=>"<string>", "timezone"=>"<string>", "ip"=>"<string>"}}, "id"=>"<string>", "meta"=>{"patch_properties"=>{"unset"=>"<string>"}}}}, "events"=>{"data"=>[{"type"=>"event", "attributes"=>{"metric"=>{"data"=>{"type"=>"metric", "attributes"=>{"name"=>"<string>", "service"=>"<string>"}}}, "time"=>"<dateTime>", "value"=>"<number>", "value_currency"=>"<string>", "unique_id"=>"<string>"}}, {"type"=>"event", "attributes"=>{"metric"=>{"data"=>{"type"=>"metric", "attributes"=>{"name"=>"<string>", "service"=>"<string>"}}}, "time"=>"<dateTime>", "value"=>"<number>", "value_currency"=>"<string>", "unique_id"=>"<string>"}}]}}}]}}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring
Acceptstring