Address Updated
Contacts API Webhooks

Triggered when a contact's address is updated.

Note: This webhook will not be triggered when a contact is added or deleted from the mailing list, nor will it be triggered when an address is changed for a single mailing.

Typical triggers include filling in missing information such as ZIP codes, providing notifications about returned mail, and sending address updates from the National Change of Address database.

Name

contacts.address_update.v1

Scope Required

contacts.read

Query Parameters

contact_id
Example: c-###-####

The contact ID used by prayerletters.com.

external_id

The contact ID supplied by your integration (or whichever integration created the contact).

Request Body

contacts.webhook.address_update.v1 Object

Example

{
   "code" : "returned_mail",
   "contact_id" : "c-###-####",
   "external_id" : "...",
   "message" : "Letter Returned -- Undeliverable As Addressed",
   "name" : "Joe and Mary Tischler",
   "new_address" : {
      "city" : "Lebanon",
      "country" : "",
      "is_deliverable" : false,
      "postal_code" : "03766",
      "state" : "NH",
      "street" : "123 Main St."
   },
   "old_address" : {
      "city" : "Lebanon",
      "country" : "",
      "is_deliverable" : true,
      "postal_code" : "03766",
      "state" : "NH",
      "street" : "123 Main St."
   },
   "updated" : "2024-04-20T09:27:01-04:00"
}
API Overview
Contacts API
Files API
Hooks API
Orders API