LettrLabs API
API ReferenceAddress Book

Create an address book entry

Adds a recipient to the account's address book, validating and standardizing the supplied address before saving it. This is the canonical path for the address book. The older `/v1/zapierActions/address-book` path is retained for existing integrations and behaves identically.

View this page as Markdown
POST
/v1/address-book

Adds a recipient to the account's address book, validating and standardizing the supplied address before saving it. This is the canonical path for the address book. The older /v1/zapierActions/address-book path is retained for existing integrations and behaves identically.

Authorization

ApiKey
X-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

firstName*string
lastName*string
toOrganization*string
address1*string
address2*string
city*string
state*string
zip*string
phoneNumber*string|null

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/address-book" \  -H "Content-Type: application/json" \  -d '{    "firstName": "string",    "lastName": "string",    "toOrganization": "string",    "address1": "string",    "address2": "string",    "city": "string",    "state": "string",    "zip": "string",    "phoneNumber": "string"  }'
{  "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": 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": {    "id": 0  },  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "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": {    "id": 0  },  "errors": [    "string"  ],  "hasErrors": true,  "warnings": [    "string"  ],  "hasWarnings": true,  "metadata": {    "property1": null,    "property2": null  }}
Empty

Record a QR code scan POST

Records a QR code scan event against an order recipient, updating that recipient's engagement statistics. Processing is asynchronous — the scan is queued and applied shortly after the request succeeds.

Add an address book entry POST

Adds a recipient to the account's address book, validating and standardizing the supplied address before saving it.