Skip to main content
PUT
/
recipients
/
{recipientId}
Update Recipient
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mailing_list_id: 1,
    name: 'Tobias Example',
    company: 'www.thanks.io',
    address: '123 Main Street',
    address2: 'Apartment 1',
    city: 'Any Town',
    province: 'KS',
    postal_code: '12345',
    country: 'US',
    dob: '1981-04-23',
    email: '[email protected]',
    phone: '+1 (555) 123-4567',
    custom1: 'Unique Info',
    custom2: 'For example a product code or customer ID',
    custom3: 'Any Extra Info',
    custom4: 'Any Extra Info'
  })
};

fetch('https://api.thanks.io/api/v2/recipients/{recipientId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "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 token authentication using your thanks.io API key

Path Parameters

​
recipientId
integer
required

ID of recipient

Example:

296446

Body

application/json
​
mailing_list_id
integer
Example:

1

​
name
string
Example:

"Tobias Example"

​
company
string
Example:

"www.thanks.io"

​
address
string
Example:

"123 Main Street"

​
address2
string
Example:

"Apartment 1"

​
city
string
Example:

"Any Town"

​
province
string

State or Province

Example:

"KS"

​
postal_code
string
Example:

"12345"

​
country
string
Example:

"US"

​
dob
string

Date of Birth in ISO 8601 format (YYYY-MM-DD) or null if not set. If provided as MM/DD/YYYY in requests, it will be converted to ISO 8601 format.

Example:

"1981-04-23"

​
email
string
​
phone
string
Example:

"+1 (555) 123-4567"

​
custom1
string

Custom field for additional information about the recipient

Example:

"Unique Info"

​
custom2
string

Custom field for additional information about the recipient

Example:

"For example a product code or customer ID"

​
custom3
string

Custom field for additional information about the recipient

Example:

"Any Extra Info"

​
custom4
string

Custom field for additional information about the recipient

Example:

"Any Extra Info"

Response

Successful Response

​
id
integer
Example:

18113288

​
mailing_list_id
integer
Example:

1

​
name
string
Example:

"Tobias Example"

​
company
string
Example:

"www.thanks.io"

​
address
string
Example:

"123 Main Street"

​
address2
string
Example:

"Apartment 1"

​
city
string
Example:

"Any Town"

​
province
string

State or Province

Example:

"KS"

​
postal_code
string
Example:

"12345"

​
country
string
Example:

"US"

​
dob
string

Date of Birth in ISO 8601 format (YYYY-MM-DD) or null if not set. If provided as MM/DD/YYYY in requests, it will be converted to ISO 8601 format.

Example:

"1981-04-23"

​
email
string
​
phone
string
Example:

"+1 (555) 123-4567"

​
custom1
string

Custom field for additional information about the recipient

Example:

"Unique Info"

​
custom2
string

Custom field for additional information about the recipient

Example:

"For example a product code or customer ID"

​
custom3
string

Custom field for additional information about the recipient

Example:

"Any Extra Info"

​
custom4
string

Custom field for additional information about the recipient

Example:

"Any Extra Info"

​
mailing-list
object

The mailing list this recipient belongs to

​
created_at
string
Example:

"2025-06-27T14:57:11.000000Z"

​
updated_at
string
Example:

"2025-06-27T14:57:11.000000Z"