POST
/
recipients
curl --request POST \
  --url https://api.thanks.io/api/v2/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "mailing_list_id": 1,
  "name": "Tobias Example",
  "company": "thanks.io",
  "address": "12345 Main Street",
  "address2": "Apartment 1",
  "city": "Any Town",
  "province": "NY",
  "postal_code": "12345",
  "country": "US",
  "dob": "1981-04-23",
  "email": "[email protected]",
  "phone": "845-988-6485",
  "custom1": "Unique Info",
  "custom2": "For example a product code or customer ID",
  "custom3": "",
  "custom4": ""
}'
{
  "id": 18113288,
  "mailing_list_id": 1,
  "name": "Tobias Example",
  "company": "thanks.io",
  "address": "12345 Main Street",
  "address2": "Apartment 1",
  "city": "Any Town",
  "province": "NY",
  "postal_code": "12345",
  "country": "US",
  "dob": "1981-04-23",
  "email": "[email protected]",
  "phone": "845-988-6485",
  "custom1": "Unique Info",
  "custom2": "For example a product code or customer ID",
  "custom3": "",
  "custom4": "",
  "created_at": "2025-06-27T14:57:11.000000Z",
  "updated_at": "2025-06-27T14:57:11.000000Z",
  "mailing_list": {
    "id": 1,
    "user_id": 2,
    "sub_account_id": null,
    "type": "manual",
    "description": "Sphere Contacts Mailing List",
    "qrcode_url": null,
    "total_recipients": 1,
    "processed": true,
    "is_suppression_list": false,
    "total_scans": 1,
    "unique_scans": 1,
    "last_scan": "2025-07-13T13:57:11.000000Z",
    "total_sends": 2,
    "last_send": "2025-07-06T13:57:11.000000Z",
    "created_at": "6 years ago",
    "updated_at": "2025-06-27T14:57:11.000000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a recipient by providing address details

Response

200
application/json

Successful Response

The response is of type object.