Imports

Stage past jobs or customers for a reactivation campaign

Push a batch of up to 500 completed jobs (or customers). Mailr geocodes every address and stages the batch — nothing is mailed and no campaign is created. The campaign wizard reads the staged batch later, in the exact shape a CSV upload produces.

Geocoding happens before any write, so a geocoder outage never leaves a half-written batch and never burns a daily slot. Rows with no address are skipped (not an error); rows that fail geocoding are staged as geocode_failed. Duplicate addresses within a batch are allowed and geocoded independently — the wizard’s selection step is where an operator prunes.

Limits: at most 500 rows per request, a 1 MB request body, and 10 batches per org per UTC day.

Retries are replay-safe: send an Idempotency-Key header and a repeat with the same key returns the existing batch (200, not 201) instead of staging a new one, without re-geocoding or spending a daily slot. A retry that lands while the original request is still processing gets a 409 import_in_progress (with Retry-After) — keep retrying with the same key until the finished batch comes back. Keyless imports never dedup — addresses are never deduplicated either way.

POST

api

import

jobs

Stage past jobs or customers for a reactivation campaign

curl --request POST \
  --url https://app.getmailr.com/api/v1/import/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "jobs",
  "rows": [
    {
      "external_id": "job-8842",
      "address": "3134 River Valley Dr, Austin, TX 78701",
      "customer_name": "Dana Reyes",
      "completed_at": "2026-05-02"
    },
    {
      "external_id": "job-8843",
      "address": "500 Congress Ave, Austin, TX 78701",
      "customer_name": "Sam Okafor"
    }
  ]
}
'

import requests

url = "https://app.getmailr.com/api/v1/import/jobs"

payload = {
    "source": "jobs",
    "rows": [
        {
            "external_id": "job-8842",
            "address": "3134 River Valley Dr, Austin, TX 78701",
            "customer_name": "Dana Reyes",
            "completed_at": "2026-05-02"
        },
        {
            "external_id": "job-8843",
            "address": "500 Congress Ave, Austin, TX 78701",
            "customer_name": "Sam Okafor"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source: 'jobs',
    rows: [
      {
        external_id: 'job-8842',
        address: '3134 River Valley Dr, Austin, TX 78701',
        customer_name: 'Dana Reyes',
        completed_at: '2026-05-02'
      },
      {
        external_id: 'job-8843',
        address: '500 Congress Ave, Austin, TX 78701',
        customer_name: 'Sam Okafor'
      }
    ]
  })
};

fetch('https://app.getmailr.com/api/v1/import/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.getmailr.com/api/v1/import/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source' => 'jobs',
    'rows' => [
        [
                'external_id' => 'job-8842',
                'address' => '3134 River Valley Dr, Austin, TX 78701',
                'customer_name' => 'Dana Reyes',
                'completed_at' => '2026-05-02'
        ],
        [
                'external_id' => 'job-8843',
                'address' => '500 Congress Ave, Austin, TX 78701',
                'customer_name' => 'Sam Okafor'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.getmailr.com/api/v1/import/jobs"

	payload := strings.NewReader("{\n  \"source\": \"jobs\",\n  \"rows\": [\n    {\n      \"external_id\": \"job-8842\",\n      \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n      \"customer_name\": \"Dana Reyes\",\n      \"completed_at\": \"2026-05-02\"\n    },\n    {\n      \"external_id\": \"job-8843\",\n      \"address\": \"500 Congress Ave, Austin, TX 78701\",\n      \"customer_name\": \"Sam Okafor\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.getmailr.com/api/v1/import/jobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": \"jobs\",\n  \"rows\": [\n    {\n      \"external_id\": \"job-8842\",\n      \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n      \"customer_name\": \"Dana Reyes\",\n      \"completed_at\": \"2026-05-02\"\n    },\n    {\n      \"external_id\": \"job-8843\",\n      \"address\": \"500 Congress Ave, Austin, TX 78701\",\n      \"customer_name\": \"Sam Okafor\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.getmailr.com/api/v1/import/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source\": \"jobs\",\n  \"rows\": [\n    {\n      \"external_id\": \"job-8842\",\n      \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n      \"customer_name\": \"Dana Reyes\",\n      \"completed_at\": \"2026-05-02\"\n    },\n    {\n      \"external_id\": \"job-8843\",\n      \"address\": \"500 Congress Ave, Austin, TX 78701\",\n      \"customer_name\": \"Sam Okafor\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "import_id": "f0e1d2c3-0000-0000-0000-000000000abc",
  "staged": 2,
  "skipped_no_address": 0,
  "skipped_geocode_failed": 0
}

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

Optional replay key. A retry carrying a key already seen returns the existing batch and its stored counts (200, not 201) without re-geocoding or spending a daily slot — or 409 while the original request is still processing. Over 255 chars → 422. Keyless imports never dedup.

Maximum string length: 255

Body

application/json

source

enum<string>

required

Available options:

jobs,

customers

rows

object[]

required

Required array length: 1 - 500 elements

Show child attributes

Response

Replay of a prior Idempotency-Key — the existing batch and its stored counts are returned (nothing new was created).

import_id

string<uuid>

required

staged

integer

required

Rows geocoded and staged.

skipped_no_address

integer

required

Rows with no address.

skipped_geocode_failed

integer

required

Rows whose address could not be geocoded.

⌘I

Stage past jobs or customers for a reactivation campaign

curl --request POST \
  --url https://app.getmailr.com/api/v1/import/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": "jobs",
  "rows": [
    {
      "external_id": "job-8842",
      "address": "3134 River Valley Dr, Austin, TX 78701",
      "customer_name": "Dana Reyes",
      "completed_at": "2026-05-02"
    },
    {
      "external_id": "job-8843",
      "address": "500 Congress Ave, Austin, TX 78701",
      "customer_name": "Sam Okafor"
    }
  ]
}
'

import requests

url = "https://app.getmailr.com/api/v1/import/jobs"

payload = {
    "source": "jobs",
    "rows": [
        {
            "external_id": "job-8842",
            "address": "3134 River Valley Dr, Austin, TX 78701",
            "customer_name": "Dana Reyes",
            "completed_at": "2026-05-02"
        },
        {
            "external_id": "job-8843",
            "address": "500 Congress Ave, Austin, TX 78701",
            "customer_name": "Sam Okafor"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    source: 'jobs',
    rows: [
      {
        external_id: 'job-8842',
        address: '3134 River Valley Dr, Austin, TX 78701',
        customer_name: 'Dana Reyes',
        completed_at: '2026-05-02'
      },
      {
        external_id: 'job-8843',
        address: '500 Congress Ave, Austin, TX 78701',
        customer_name: 'Sam Okafor'
      }
    ]
  })
};

fetch('https://app.getmailr.com/api/v1/import/jobs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.getmailr.com/api/v1/import/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'source' => 'jobs',
    'rows' => [
        [
                'external_id' => 'job-8842',
                'address' => '3134 River Valley Dr, Austin, TX 78701',
                'customer_name' => 'Dana Reyes',
                'completed_at' => '2026-05-02'
        ],
        [
                'external_id' => 'job-8843',
                'address' => '500 Congress Ave, Austin, TX 78701',
                'customer_name' => 'Sam Okafor'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.getmailr.com/api/v1/import/jobs"

	payload := strings.NewReader("{\n  \"source\": \"jobs\",\n  \"rows\": [\n    {\n      \"external_id\": \"job-8842\",\n      \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n      \"customer_name\": \"Dana Reyes\",\n      \"completed_at\": \"2026-05-02\"\n    },\n    {\n      \"external_id\": \"job-8843\",\n      \"address\": \"500 Congress Ave, Austin, TX 78701\",\n      \"customer_name\": \"Sam Okafor\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.getmailr.com/api/v1/import/jobs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": \"jobs\",\n  \"rows\": [\n    {\n      \"external_id\": \"job-8842\",\n      \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n      \"customer_name\": \"Dana Reyes\",\n      \"completed_at\": \"2026-05-02\"\n    },\n    {\n      \"external_id\": \"job-8843\",\n      \"address\": \"500 Congress Ave, Austin, TX 78701\",\n      \"customer_name\": \"Sam Okafor\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.getmailr.com/api/v1/import/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"source\": \"jobs\",\n  \"rows\": [\n    {\n      \"external_id\": \"job-8842\",\n      \"address\": \"3134 River Valley Dr, Austin, TX 78701\",\n      \"customer_name\": \"Dana Reyes\",\n      \"completed_at\": \"2026-05-02\"\n    },\n    {\n      \"external_id\": \"job-8843\",\n      \"address\": \"500 Congress Ave, Austin, TX 78701\",\n      \"customer_name\": \"Sam Okafor\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "import_id": "f0e1d2c3-0000-0000-0000-000000000abc",
  "staged": 2,
  "skipped_no_address": 0,
  "skipped_geocode_failed": 0
}

Developer API

Endpoints

Stage past jobs or customers for a reactivation campaign

Authorizations

Headers

Body

Response