API ReferenceConversions
Create conversions
Submits conversion events for matchback and attribution. Returns validation information and processes the valid records even when some records are invalid. At most 5,000 records per request — a larger batch is rejected in full with a 400 and none of it is processed, so split larger uploads client-side.
Submits conversion events for matchback and attribution. Returns validation information and processes the valid records even when some records are invalid. At most 5,000 records per request — a larger batch is rejected in full with a 400 and none of it is processed, so split larger uploads client-side.
Authorization
ApiKey X-API-KEY<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
[index: integer]?
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/conversions" \ -H "Content-Type: application/json" \ -d '[ { "firstName": "string", "lastName": "string", "fullName": "string", "businessName": "string", "primaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "secondaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "couponCode": "string", "primaryPhoneNumber": "string", "secondaryPhoneNumber": "string", "primaryEmail": "user@example.com", "secondaryEmail": "user@example.com", "revenue": "string", "type": "Conversion", "orderId": "string", "storeId": "string", "uniqueId": "string", "crmId": "string", "customerId": "string", "eventDate": "2019-08-24T14:15:22Z" } ]'{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": [ { "firstName": "string", "lastName": "string", "fullName": "string", "businessName": "string", "primaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "secondaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "couponCode": "string", "primaryPhoneNumber": "string", "secondaryPhoneNumber": "string", "primaryEmail": "user@example.com", "secondaryEmail": "user@example.com", "revenue": "string", "type": "Conversion", "orderId": "string", "storeId": "string", "uniqueId": "string", "crmId": "string", "customerId": "string", "eventDate": "2019-08-24T14:15:22Z" } ], "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": [ { "firstName": "string", "lastName": "string", "fullName": "string", "businessName": "string", "primaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "secondaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "couponCode": "string", "primaryPhoneNumber": "string", "secondaryPhoneNumber": "string", "primaryEmail": "user@example.com", "secondaryEmail": "user@example.com", "revenue": "string", "type": "Conversion", "orderId": "string", "storeId": "string", "uniqueId": "string", "crmId": "string", "customerId": "string", "eventDate": "2019-08-24T14:15:22Z" } ], "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": [ { "firstName": "string", "lastName": "string", "fullName": "string", "businessName": "string", "primaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "secondaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "couponCode": "string", "primaryPhoneNumber": "string", "secondaryPhoneNumber": "string", "primaryEmail": "user@example.com", "secondaryEmail": "user@example.com", "revenue": "string", "type": "Conversion", "orderId": "string", "storeId": "string", "uniqueId": "string", "crmId": "string", "customerId": "string", "eventDate": "2019-08-24T14:15:22Z" } ], "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": [ { "firstName": "string", "lastName": "string", "fullName": "string", "businessName": "string", "primaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "secondaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "couponCode": "string", "primaryPhoneNumber": "string", "secondaryPhoneNumber": "string", "primaryEmail": "user@example.com", "secondaryEmail": "user@example.com", "revenue": "string", "type": "Conversion", "orderId": "string", "storeId": "string", "uniqueId": "string", "crmId": "string", "customerId": "string", "eventDate": "2019-08-24T14:15:22Z" } ], "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": [ { "firstName": "string", "lastName": "string", "fullName": "string", "businessName": "string", "primaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "secondaryAddress": { "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string" }, "couponCode": "string", "primaryPhoneNumber": "string", "secondaryPhoneNumber": "string", "primaryEmail": "user@example.com", "secondaryEmail": "user@example.com", "revenue": "string", "type": "Conversion", "orderId": "string", "storeId": "string", "uniqueId": "string", "crmId": "string", "customerId": "string", "eventDate": "2019-08-24T14:15:22Z" } ], "errorCode": "UNAUTHENTICATED", "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "errorDetails": [ null ], "metadata": { "property1": null, "property2": null }}Retrieve a conversion's status GET
Returns the processing status of one conversion by its ID, including whether it has been matched or is pending deletion.
List integration orders GET
Returns the account's integration orders (automations) — standing orders that mail each recipient added to them — with their template and configuration details.