Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

Inbound Email

Driftwood provides each user with a unique BCC address. Forward or BCC emails to this address to automatically log them as activities on the matching contact.

  1. Each user gets a unique BCC email address (e.g., user-token@bcc.driftwoodapp.com)
  2. When you BCC this address on an email, Driftwood receives it
  3. Driftwood matches the email’s recipients to contacts in your account
  4. An email activity is automatically created on the matched contact

Endpoint: inbound-emails-bcc-address

Terminal window
curl -X POST https://api.driftwoodapp.com/api/inbound-emails-bcc-address \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'

Response:

{
"ok": true,
"result": {
"address": "abc123@bcc.driftwoodapp.com"
}
}

If your BCC address is compromised, generate a new one. The old address will stop working immediately.

Endpoint: inbound-emails-generate-token

Terminal window
curl -X POST https://api.driftwoodapp.com/api/inbound-emails-generate-token \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'

Endpoint: inbound-emails-rotate-token

Same as generate but replaces an existing token.

View processed inbound emails and their matching status.

Endpoint: inbound-emails-list

FieldTypeRequiredDescription
contact_iduuidNoFilter by matched contact
company_iduuidNoFilter by matched company
statusstringNoFilter by status
cursorstringNoPagination cursor
limitintegerNoResults per page

Response includes:

FieldTypeDescription
iduuidEmail ID
from_addressstringSender email
to_addressesstring[]Recipients
cc_addressesstring[]CC recipients
subjectstringEmail subject
body_textstringPlain text body
body_htmlstringHTML body
contact_iduuid | nullMatched contact
contact_namestringMatched contact name
statusstringProcessing status
created_atdatetimeWhen received

Block specific email addresses or domains from creating activities.

Endpoint: blocked-senders-list

Terminal window
curl -X POST https://api.driftwoodapp.com/api/blocked-senders-list \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'

Endpoint: blocked-senders-create

FieldTypeRequiredDescription
emailstringNo*Block a specific email address
domainstringNo*Block an entire domain

*Provide either email or domain.

Terminal window
curl -X POST https://api.driftwoodapp.com/api/blocked-senders-create \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"domain": "spam-domain.com"}'

Endpoint: blocked-senders-delete

FieldTypeRequiredDescription
iduuidYesBlocked sender ID