Update a contact

PATCH/v1/contacts/{id}API key

Only the fields you send change. Unlike Create a contact, null here clears a field. The email address can't be changed; create a new contact instead.

Setting unsubscribed to false puts a contact back on your broadcasts. Only do that when the person asked for it. See Unsubscribe.

Path parameters

idstringpathrequired

The contact ID.

Body parameters

firstNamestring | null

Up to 200 characters. null clears it.

lastNamestring | null

Up to 200 characters. null clears it.

unsubscribedboolean

true makes broadcasts skip this contact.

dataobject | null

Replaces the stored data object as a whole. null clears it.

Response

The updated contact, with the fields described in Create a contact.

Errors

Status	Code	When
400	`missing_body`	The request has no body.
400	`invalid_body`	A field has the wrong type or length.
404	`contact_not_found`	No contact with that ID in this project.

Request

import { Flaresend } from '@flaresend/client';

const flaresend = new Flaresend({
  apiKey: process.env.FLARESEND_API_KEY!,
  baseUrl: 'https://mailer.example.com',
});

const contact = await flaresend.contacts.update('ct_01K6C1M3R8T2V9X4Z6B7N5P0QA', {
  unsubscribed: true,
  data: null,
});

Response

{
  "id": "ct_01K6C1M3R8T2V9X4Z6B7N5P0QA",
  "projectId": "proj_01K5Z8W2Q4R6T8V0X2Z4B6D8FG",
  "email": "ada@example.com",
  "firstName": "Ada",
  "lastName": "Lovelace",
  "unsubscribed": true,
  "data": null,
  "createdAt": "2026-09-26T10:00:00.000Z",
  "updatedAt": "2026-09-26T11:30:00.000Z"
}

Path parametersCopy Anchor Link

Body parametersCopy Anchor Link

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

Path parameters

Body parameters

Response

Errors