Skip to content
Addressable API Overview
Endpoints
Root URL
https://api.addressable.app/api/v1
All requests are relative to this root url.
Authentication
Authentication is managed via headers.
Headers
X-User-Email: <EMAIL_ADDRESS>
X-User-Token: <API_KEY>
Custom Notes
Mailings of single cards are known as custom notes.
GET /custom_notes.json
https://api.addressable.app/api/v1/custom_notes.json
Lists last 100 custom notes for account.
POST /custom_notes.json
https://api.addressable.app/api/v1/custom_notes.json
Request Body
{
"custom_note":
{
"body": "Hi John,\r\n\r\nThank you for meeting with me last week.\r\n\r\nCheers,\r\nChris",
"to_first_name": "John",
"to_last_name": "Smith",
"to_business_name": "",
"to_address_line_1": "1 Main st",
"to_address_line_2": "unit 123",
"to_city": "San Francisco",
"to_state": "CA",
"to_zipcode": "94102",
"from_first_name": "Chris",
"from_last_name": "Tosswill",
"from_business_name": "ConversionRobots",
"from_address_line_1": "1 polk street",
"from_address_line_2": "",
"from_city": "San Francisco",
"from_state": "CA",
"from_zipcode": "94102"
}
}
Creates and sends a custom note.
Layout Templates
Layout templates define the outside look of the card.
GET /layout_templates.json
GET https://api.addressable.app/api/v1/layout_templates.json
Message Templates
Message templates define the inside message copy and support merge tags.
GET /layout_templates.json
GET https://api.addressable.app/api/v1/message_templates.json
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.