Create an account custom activity event (create)

The create Ortto endpoint of the accounts/activities entity is used to create one or more custom account activity events in Ortto.

This page provides descriptions of this endpoint’s:

• request resource and method,
• valid parameters, headers, and request body values, as well as
• the response payload.

HTTP method and request resources

 
POST https://api.ap3api.com/v1/accounts/activities/create

Path and query parameters

This endpoint takes no additional path and/or query parameters.

Headers

This endpoint requires a custom API key and content type (application/json for the request body) in the header of the request:

• X-Api-Key: CUSTOM-PRIVATE-API-KEY
• Content-Type: application/json

Request body

The request body consists of a JSON object with the valid elements listed in the table below.

The following JSON objects are examples of requests to create account custom activities in your Ortto account.

Example create an account custom activity event request body

json
 
{	
"activities": [
		{
			"activity_id": "act:oc:flight-booked",
			"attributes": {
				"int::v": 17500,
				"str:cm:carrier": "Easy Jet",
				"str:cm:destination": "London"
			},
			"fields": {
				"str:o:name": "CompanyName"
			}
		}
	],
	"merge_by": [
		"str:o:name"
	]
}

You can also merge account records using the Account ID. This approach restricts the updates you can make to the account at the same time as raising the activity, but it results in much faster processing since the direct account is known and doesn't need to be looked up using a filter.

Example create account custom activity event request body and merge by Account ID

json
 
{
    "activities": [
        {
            "activity_id": "act:cm:flight-booked",
            "str:o:organization_id": "00671822e88c13e21abf2302",
            "attributes": {
                "int::v": 15300,
                "str:cm:destination": "London",
                "str:cm:carrier": "Easy Jet"
            }
        }
    ]
}

Custom activity request limits

It is possible to send up to 100 activities in the one payload to Ortto. The limits are as follows:

• 100 activities max
• 2 MB total payload size

In addition to the above, the number of activities per account per day is limited. The limit is 50 activity events per activity per account per 24 hours.

Valid request body elements

The following table lists all valid request body elements (arrays, objects, or fields), which are available to this endpoint.

Response payload

The response payload consists of a JSON object with the elements listed in the table below.

The following JSON object is an example of account data that Ortto retrieves from your Ortto account after a request to this endpoint.

Example create account custom activity event response payload from Ortto’s CDP

json
 
{
    "activities": [
        {
            "account_id": "1068629810d60d04d18af600",
            "status": "ingested",
            "account_status": "merged",
            "activity_id": "0068629af6fee095c7834342"
        }
    ]
}

Response payload elements

The following table lists all elements (arrays, objects, or fields) in the response from a request to this endpoint.

Backdating activities

If you would like to backdate activity data, you can use the created field in your request to specify the date on which the activity occurred. Ortto allows you to send in backdated events up to 90 days in the past, or if you have data retention enabled on your activity, you may provide backdated events up to your selected data retention period.

In addition, to make sure you do not backfill the same piece of data more than once, you can include a key attribute, which gets combined with the created date to create a unique identifier for each activity. If you provide the same pair for key and created multiple times (such as if you need to run your backfill scripts multiple times), it will merge those requests so you do not get duplicate activities created.

json
 
{ 
  "activities": [ 
    { 
    "activity_id": "act:cm:flight-booked", 
    "created": "2025-06-30T01:30:17.601Z", 
    "key": "125432", 
    "str:o:organization_id": "00671822e88c13e21abf2302", 
    "attributes": { 
      "int::v": 15300, 
       "str:cm:destination": "London", 
        "str:cm:carrier": "Easy Jet" 
      } 
    } 
  ] 
}

As this documentation will age, if you copy the above example verbatim you might get a response like below:

json
 
{
  "request_id": "19ccd5c1-112d-4dfa-bf80-0a3312896742",
  "code": 400,
  "error":" Created date is more than 90 days ago"
}

If you provide a created date within the last 90 days (or within your activity’s selected data retention period), you will receive a successful response:

json
 
{
    "activities":
        [
            {
                "account_id":"00602c446af92b7aa1f77a00",
                "status":"ingested",
                "account_status":"created",
                "activity_id":"00602c71a9b346c32c9b7473"
            }
        ]
}

If you provide a created date outside of the activity’s selected data retention period, you will receive an error response:

json
 
{
  "request_id": "19ccd5c1-112d-4dfa-bf80-0a3312896742",
  "code": 400,
  "error":" Created date is outside of activity cold storage"
}

Learn more about configuring data retention.