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

Orders

Operations

Automations

Operations

Retrieve Integration Orders

Request

Gets all integration orders for the profile.

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

Responses

successful operation

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": {}
  }
}

Add Recipient

Request

Add a recipient into a integration order by Id. If the integration order is Active, recipient will be added to queue to be mailed to.

Security
apikey
Path
idinteger(int32)required

ID of integration order to add recipient to.

Bodyapplication/jsonrequired

The recipient to add.

idinteger(int32)

Order Recipient ID

firstNamestring

Order Recipient First Name

lastNamestring

Order Recipient Last Name

toOrganizationstring

Order Recipient Organization

address1string

Order Recipient Address Line 1

address2string

Order Recipient Address Line 2

citystring

Order Recipient City

statestring

Order Recipient State

zipCodestring

Order Recipient Zip Code

countrystring

Order Recipient Country

custom1string

Order Recipient Custom Field 1 for Mail-Merge.

custom2string

Recipient Custom Field 2 for Mail-Merge.

custom3string

Recipient Custom Field 3 for Mail-Merge.

custom4string

Recipient Custom Field 4 for Mail-Merge.

custom5string

Recipient Custom Field 5 for Mail-Merge.

custom6string

Recipient Custom Field 6 for Mail-Merge.

salutationstring

Recipient Salutation

birthDaystring(date-time)

Recipient Birthday

anniversarystring(date-time)

Recipient Anniversary

returnTitlestring

Return Address Title

returnFirstNamestring

Mailpiece Return Address First Name. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

returnLastNamestring

Mailpiece Return Address Last Name. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

returnOrganizationstring

Mailpiece Return Address Organization. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

returnAddress1string

Mailpiece Return Address Line 1. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

returnAddress2string

Mailpiece Return Address Line 2. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

returnCitystring

Mailpiece Return Address City. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

returnStatestring

Mailpiece Return Address State. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

returnZipstring

Mailpiece Return Address Zip Code. Use this to override the template's return address. If using the override, must provide full return address through endpoint.

qrUrlstring

Mailpiece QR Code URL. Use this to override the template's QR code and provide a unique QR URL per recipient.

fullAddressstring

Recipient Full Address (Optional)

curl -i -X POST \
  'https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/v1/integration-orders/{id}/recipients' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "firstName": "string",
    "lastName": "string",
    "toOrganization": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "country": "string",
    "custom1": "string",
    "custom2": "string",
    "custom3": "string",
    "custom4": "string",
    "custom5": "string",
    "custom6": "string",
    "salutation": "string",
    "birthDay": "2019-08-24T14:15:22Z",
    "anniversary": "2019-08-24T14:15:22Z",
    "returnTitle": "string",
    "returnFirstName": "string",
    "returnLastName": "string",
    "returnOrganization": "string",
    "returnAddress1": "string",
    "returnAddress2": "string",
    "returnCity": "string",
    "returnState": "string",
    "returnZip": "string",
    "qrUrl": "string",
    "fullAddress": "string"
  }'

Responses

successful operation

Bodyapplication/json
profileobject(profile)
payloadobject(integrationOrder)
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,
    "name": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "postageType": "string",
    "integrationOrderStatus": "string"
  },
  "errors": [
    "string"
  ],
  "hasErrors": true,
  "warnings": [
    "string"
  ],
  "hasWarnings": true,
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Radius Mail

Request

Initiate a Radius Mail order centered around the list of provided addresses. Each address in the list will initiate a Radius Mailing with the provided filter settings. Recipients will be queried and added to the provided integration order.

Security
apikey
Path
idinteger(int32)required

ID of integration order add recipients to.

Bodyapplication/jsonrequired

Filters to be used when finding recipients around the provided coordinates.

namestring
ownerOrRenterFilterinteger or null(int32)
Default 0
Enum01
propertyTypeFilterinteger or null(int32)
Default 0
Enum012
houseHoldIncomeFilterobject(householdIncome)
lengthOfResidenceFilterobject(lengthOfResidence)
yearBuiltFilterobject(yearBuilt)
addressesArray of objects(address)
multiUseboolean or null
curl -i -X POST \
  'https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/v1/integration-orders/{id:int}:mail-by-proximity' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "ownerOrRenterFilter": 0,
    "propertyTypeFilter": 0,
    "houseHoldIncomeFilter": {
      "min": 0,
      "max": 0
    },
    "lengthOfResidenceFilter": {
      "min": 0,
      "max": 0
    },
    "yearBuiltFilter": {
      "min": 0,
      "max": 0
    },
    "addresses": [
      {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "desiredCount": 0
      }
    ],
    "multiUse": true
  }'

Responses

successful operation

Bodyapplication/json
profileobject(profile)
payloadobject(integrationOrder)
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,
    "name": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "updatedDate": "2019-08-24T14:15:22Z",
    "postageType": "string",
    "integrationOrderStatus": "string"
  },
  "errors": [
    "string"
  ],
  "hasErrors": true,
  "warnings": [
    "string"
  ],
  "hasWarnings": true,
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Order Recipient Analytics

Operations

Address Book

Operations