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

Order Recipient Analytics

Operations

Address Book

Operations

Add Recipient

Request

Add a new recipient into the address book.

Security
apikey
Bodyapplication/jsonrequired

Recipient data.

firstNamestring
lastNamestring
toOrganizationstring
address1string
address2string
citystring
statestring
zipstring
curl -i -X POST \
  https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/v1/zapierActions/address-book \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "toOrganization": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string"
  }'

Responses

successful operation

Bodyapplication/json
profileobject(profile)
payloadobject(addressBookResponse)
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
  },
  "errors": [
    "string"
  ],
  "hasErrors": true,
  "warnings": [
    "string"
  ],
  "hasWarnings": true,
  "metadata": {
    "property1": {},
    "property2": {}
  }
}