Register existing customers for suppression

POST

api

customers

webhook

curl --request POST \
  --url https://app.getmailr.com/api/v1/customers/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "3134 River Valley Dr, Austin, TX 78701",
  "notes": "annual maintenance plan"
}
'

{
  "added": 2,
  "total": 2
}

Authorizations

Authorization

string

header

required

Organization-scoped Mailr API key. Header: Authorization: Bearer ak_….

Body

application/json

Option 1
Option 2

address

string

required

notes

string | null

Response

Upsert result.

added

integer

How many addresses were upserted.

total

integer

How many valid addresses were supplied.

⌘I

curl --request POST \
  --url https://app.getmailr.com/api/v1/customers/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "3134 River Valley Dr, Austin, TX 78701",
  "notes": "annual maintenance plan"
}
'

{
  "added": 2,
  "total": 2
}

Developer API

Endpoints

Register existing customers for suppression

Authorizations

Body

Response