Skip to content

LettrLabs Public API Documentation (1.0.0)

LettrLabs Public API Documentation.

Download OpenAPI description
LettrLabs_API_Reference.json
LettrLabs_API_Reference.yaml
Languages
Servers
Mock server

https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/

https://app.lettrlabs.com/api/

Conversions

Operations

Post multiple conversions

Request

Posts multiple conversions with validation. Returns validation information and processes valid records even if some are invalid.

Security
apikey
Bodyapplication/jsonrequired

Provide conversion events and values for matchback and attribution. The more personal information that can be provided, the better the matchback quality. Must provide atleast 1 piece of personal information, and a conversion value. If no date is provided, the event is assumed to occur at the time of the call.

Array [
firstNamestring[ 0 .. 255 ] characters

Converted Person's First Name

lastNamestring[ 0 .. 255 ] characters

Converted Person's Last Name

fullNamestring[ 0 .. 255 ] characters

Converted Person's Full Name

businessNamestring[ 0 .. 255 ] characters

Converted Business' Name

primaryAddressobject(conversionAddressViewModel)

Converted Entity's Primary Address

secondaryAddressobject(conversionAddressViewModel)

Converted Entity's Primary Address

couponCodestring[ 0 .. 255 ] characters

Converted Purchase Coupon Code

primaryPhoneNumberstring[ 0 .. 20 ] characters

Converted Entity's Primary Phone Number

secondaryPhoneNumberstring[ 0 .. 20 ] characters

Converted Entity's Secondary Phone Number

primaryEmailstring(email)[ 0 .. 255 ] characters

Converted Entity's Primary Email

secondaryEmailstring(email)[ 0 .. 255 ] characters

Converted Entity's Secondary Email

revenuenumber(double)[ 0 .. 7.922816251426434e+28 ]

Converted Revenue

orderIdstring[ 0 .. 255 ] characters

Converted Order ID. Providing an Order ID is recommended to avoid duplication of conversions.

storeIdstring[ 0 .. 255 ] characters

Converted Store ID. Providing a Store ID is recommended to help classify conversions.

uniqueIdstring[ 0 .. 255 ] characters

Provide a Unique ID as a pass through field. This allows you to tie data back when exporting to your CRM.

crmIdstring[ 0 .. 255 ] characters

Provide a CRM ID as a pass through field. This allows you to tie data back when exporting to your CRM.

customerIdstring[ 0 .. 255 ] characters

Provide a unique Customer ID to help tie data back to a specific customer.

eventDatestring(date-time)

Date and time of the conversion event (UTC). This is the date the conversion occurred. Providing no date will default to the current date and time. Please use standard IDO datetime formats.

]
curl -i -X POST \
  https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/v1/conversions \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -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": 7.922816251426434e+28,
      "orderId": "string",
      "storeId": "string",
      "uniqueId": "string",
      "crmId": "string",
      "customerId": "string",
      "eventDate": "2019-08-24T14:15:22Z"
    }
  ]'

Responses

Returns processed conversions with validation statistics in Metadata. The Metadata includes TotalRecords, ValidRecords, InvalidRecords, PrimaryEmails, SecondaryEmails, PrimaryAddresses, SecondaryAddresses, PrimaryPhones, SecondaryPhones, CouponCodes, and may include DetailedErrors and DetailedWarnings with specific validation data.

Bodyapplication/json
profileobject(profile)
payloadArray of objects(conversionViewModel)
errorsArray of strings
hasErrorsboolean
warningsArray of strings
hasWarningsboolean
metadataobject
Response
application/json
{
  "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": [
    { … }
  ],
  "errors": [
    "string"
  ],
  "hasErrors": true,
  "warnings": [
    "string"
  ],
  "hasWarnings": true,
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

List all conversions

Request

Retrieves all conversions for the authenticated user

Security
apikey
curl -i -X GET \
  https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/v1/conversions \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Returns all conversions with metadata about the response. The Metadata may include pagination details and total record counts.

Bodyapplication/json
profileobject(profile)
payloadArray of objects(conversionViewModel)
errorsArray of strings
hasErrorsboolean
warningsArray of strings
hasWarningsboolean
metadataobject
Response
application/json
{
  "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": [
    { … }
  ],
  "errors": [
    "string"
  ],
  "hasErrors": true,
  "warnings": [
    "string"
  ],
  "hasWarnings": true,
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Delete conversions

Request

Marks a specific conversion for deletion by validating its status and preparing for removal. Client must subsequently check deletion status via status endpoint.

Security
apikey
curl -i -X DELETE \
  'https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/v1/conversions/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Specified conversion has been validated and queued for deletion process

Bodyapplication/json
profileobject(profile)
payloadstring
errorsArray of strings
hasErrorsboolean
warningsArray of strings
hasWarningsboolean
metadataobject
Response
application/json
{
  "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": "string",
  "errors": [
    "string"
  ],
  "hasErrors": true,
  "warnings": [
    "string"
  ],
  "hasWarnings": true,
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Check the status of a specific conversion

Request

Returns the processing status of a specified conversion by its ID

Security
apikey
Path
idinteger(int32)required

The ID of the conversion to check

curl -i -X GET \
  'https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/v1/conversions/{id}/status' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Returns the status of the specified conversion with metadata. The Metadata may include processing timestamps and status details.

Bodyapplication/json
profileobject(profile)
payloadobject(conversionItemResponse)
errorsArray of strings
hasErrorsboolean
warningsArray of strings
hasWarningsboolean
metadataobject
Response
application/json
{
  "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": {
    "id": 0,
    "fileName": "string",
    "dataSourceType": "string",
    "status": "string",
    "uploadDate": "2019-08-24T14:15:22Z"
  },
  "errors": [
    "string"
  ],
  "hasErrors": true,
  "warnings": [
    "string"
  ],
  "hasWarnings": true,
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Orders

Operations

Automations

Operations

Order Recipient Analytics

Operations

Address Book

Operations