Update Contact
Update an existing contact.
PATCH
/
contacts
/
:contact_id
import { Resend } from 'resend';
const resend = new Resend('re_xxxxxxxxx');
const { data, error } = await resend.contacts.update({
id: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
// or: email: 'acme@example.com',
unsubscribed: true,
});
$resend = Resend::client('re_xxxxxxxxx');
// Update by contact id
$resend->contacts->update(
idOrEmail: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
parameters: [
'unsubscribed' => true
]
);
// Update by contact email
$resend->contacts->update(
idOrEmail: 'acme@example.com',
parameters: [
'unsubscribed' => true
]
);
import resend
resend.api_key = "re_xxxxxxxxx"
# Update by contact id
params: resend.Contacts.UpdateParams = {
"id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
"unsubscribed": True,
}
resend.Contacts.update(params)
# Update by contact email
params: resend.Contacts.UpdateParams = {
"email": "acme@example.com",
"unsubscribed": True,
}
resend.Contacts.update(params)
require "resend"
Resend.api_key = "re_xxxxxxxxx"
# Update by contact id
params = {
"id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
"unsubscribed": true,
}
Resend::Contacts.update(params)
# Update by contact email
params = {
"email": "acme@example.com",
"unsubscribed": true,
}
Resend::Contacts.update(params)
package main
import "github.com/resend/resend-go/v4"
func main() {
client := resend.NewClient("re_xxxxxxxxx")
// Update by contact id
params := &resend.UpdateContactRequest{
Id: "e169aa45-1ecf-4183-9955-b1499d5701d3",
Unsubscribed: true,
}
client.Contacts.Update(params)
// Update by contact email
params = &resend.UpdateContactRequest{
Email: "acme@example.com",
Unsubscribed: true,
}
client.Contacts.Update(params)
}
use resend_rs::{types::ContactChanges, Resend, Result};
#[tokio::main]
async fn main() -> Result<()> {
let resend = Resend::new("re_xxxxxxxxx");
let changes = ContactChanges::new().with_unsubscribed(true);
// Update by contact id
let _contact = resend
.contacts
.update("e169aa45-1ecf-4183-9955-b1499d5701d3", changes.clone())
.await?;
// Update by contact email
let _contact = resend
.contacts
.update("acme@example.com", changes)
.await?;
Ok(())
}
import com.resend.Resend;
import com.resend.core.exception.ResendException;
import com.resend.services.contacts.model.UpdateContactOptions;
import com.resend.services.contacts.model.UpdateContactResponseSuccess;
public class Main {
public static void main(String[] args) throws ResendException {
Resend resend = new Resend("re_xxxxxxxxx");
UpdateContactOptions params = UpdateContactOptions.builder()
.id("e169aa45-1ecf-4183-9955-b1499d5701d3") // or: .email("acme@example.com")
.unsubscribed(true)
.build();
UpdateContactResponseSuccess data = resend.contacts().update(params);
}
}
using Resend;
IResend resend = ResendClient.Create( "re_xxxxxxxxx" ); // Or from DI
// By Id
await resend.ContactUpdateAsync(
contactId: new Guid( "e169aa45-1ecf-4183-9955-b1499d5701d3" ),
new ContactData()
{
FirstName = "Stevie",
LastName = "Wozniaks",
IsUnsubscribed = true,
}
);
// By Email
await resend.ContactUpdateByEmailAsync(
"acme@example.com",
new ContactData()
{
FirstName = "Stevie",
LastName = "Wozniaks",
IsUnsubscribed = true,
}
);
# Update by contact id
curl -X PATCH 'https://api.resend.com/contacts/520784e2-887d-4c25-b53c-4ad46ad38100' \
-H 'Authorization: Bearer re_xxxxxxxxx' \
-H 'Content-Type: application/json' \
-d $'{
"unsubscribed": true
}'
# Update by contact email
curl -X PATCH 'https://api.resend.com/contacts/acme@example.com' \
-H 'Authorization: Bearer re_xxxxxxxxx' \
-H 'Content-Type: application/json' \
-d $'{
"unsubscribed": true
}'
# Update by contact id
resend contacts update e169aa45-1ecf-4183-9955-b1499d5701d3 --unsubscribed
# Update by contact email
resend contacts update acme@example.com --unsubscribed
{
"object": "contact",
"id": "479e3145-dd38-476b-932c-529ceb705947"
}
Path Parameters
Eitherid or email must be provided.
Body Parameters
The Contact’s global subscription status. If set to
true, the contact will
be unsubscribed from all Broadcasts.import { Resend } from 'resend';
const resend = new Resend('re_xxxxxxxxx');
const { data, error } = await resend.contacts.update({
id: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
// or: email: 'acme@example.com',
unsubscribed: true,
});
$resend = Resend::client('re_xxxxxxxxx');
// Update by contact id
$resend->contacts->update(
idOrEmail: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
parameters: [
'unsubscribed' => true
]
);
// Update by contact email
$resend->contacts->update(
idOrEmail: 'acme@example.com',
parameters: [
'unsubscribed' => true
]
);
import resend
resend.api_key = "re_xxxxxxxxx"
# Update by contact id
params: resend.Contacts.UpdateParams = {
"id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
"unsubscribed": True,
}
resend.Contacts.update(params)
# Update by contact email
params: resend.Contacts.UpdateParams = {
"email": "acme@example.com",
"unsubscribed": True,
}
resend.Contacts.update(params)
require "resend"
Resend.api_key = "re_xxxxxxxxx"
# Update by contact id
params = {
"id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
"unsubscribed": true,
}
Resend::Contacts.update(params)
# Update by contact email
params = {
"email": "acme@example.com",
"unsubscribed": true,
}
Resend::Contacts.update(params)
package main
import "github.com/resend/resend-go/v4"
func main() {
client := resend.NewClient("re_xxxxxxxxx")
// Update by contact id
params := &resend.UpdateContactRequest{
Id: "e169aa45-1ecf-4183-9955-b1499d5701d3",
Unsubscribed: true,
}
client.Contacts.Update(params)
// Update by contact email
params = &resend.UpdateContactRequest{
Email: "acme@example.com",
Unsubscribed: true,
}
client.Contacts.Update(params)
}
use resend_rs::{types::ContactChanges, Resend, Result};
#[tokio::main]
async fn main() -> Result<()> {
let resend = Resend::new("re_xxxxxxxxx");
let changes = ContactChanges::new().with_unsubscribed(true);
// Update by contact id
let _contact = resend
.contacts
.update("e169aa45-1ecf-4183-9955-b1499d5701d3", changes.clone())
.await?;
// Update by contact email
let _contact = resend
.contacts
.update("acme@example.com", changes)
.await?;
Ok(())
}
import com.resend.Resend;
import com.resend.core.exception.ResendException;
import com.resend.services.contacts.model.UpdateContactOptions;
import com.resend.services.contacts.model.UpdateContactResponseSuccess;
public class Main {
public static void main(String[] args) throws ResendException {
Resend resend = new Resend("re_xxxxxxxxx");
UpdateContactOptions params = UpdateContactOptions.builder()
.id("e169aa45-1ecf-4183-9955-b1499d5701d3") // or: .email("acme@example.com")
.unsubscribed(true)
.build();
UpdateContactResponseSuccess data = resend.contacts().update(params);
}
}
using Resend;
IResend resend = ResendClient.Create( "re_xxxxxxxxx" ); // Or from DI
// By Id
await resend.ContactUpdateAsync(
contactId: new Guid( "e169aa45-1ecf-4183-9955-b1499d5701d3" ),
new ContactData()
{
FirstName = "Stevie",
LastName = "Wozniaks",
IsUnsubscribed = true,
}
);
// By Email
await resend.ContactUpdateByEmailAsync(
"acme@example.com",
new ContactData()
{
FirstName = "Stevie",
LastName = "Wozniaks",
IsUnsubscribed = true,
}
);
# Update by contact id
curl -X PATCH 'https://api.resend.com/contacts/520784e2-887d-4c25-b53c-4ad46ad38100' \
-H 'Authorization: Bearer re_xxxxxxxxx' \
-H 'Content-Type: application/json' \
-d $'{
"unsubscribed": true
}'
# Update by contact email
curl -X PATCH 'https://api.resend.com/contacts/acme@example.com' \
-H 'Authorization: Bearer re_xxxxxxxxx' \
-H 'Content-Type: application/json' \
-d $'{
"unsubscribed": true
}'
# Update by contact id
resend contacts update e169aa45-1ecf-4183-9955-b1499d5701d3 --unsubscribed
# Update by contact email
resend contacts update acme@example.com --unsubscribed
{
"object": "contact",
"id": "479e3145-dd38-476b-932c-529ceb705947"
}
Was this page helpful?
⌘I
import { Resend } from 'resend';
const resend = new Resend('re_xxxxxxxxx');
const { data, error } = await resend.contacts.update({
id: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
// or: email: 'acme@example.com',
unsubscribed: true,
});
$resend = Resend::client('re_xxxxxxxxx');
// Update by contact id
$resend->contacts->update(
idOrEmail: 'e169aa45-1ecf-4183-9955-b1499d5701d3',
parameters: [
'unsubscribed' => true
]
);
// Update by contact email
$resend->contacts->update(
idOrEmail: 'acme@example.com',
parameters: [
'unsubscribed' => true
]
);
import resend
resend.api_key = "re_xxxxxxxxx"
# Update by contact id
params: resend.Contacts.UpdateParams = {
"id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
"unsubscribed": True,
}
resend.Contacts.update(params)
# Update by contact email
params: resend.Contacts.UpdateParams = {
"email": "acme@example.com",
"unsubscribed": True,
}
resend.Contacts.update(params)
require "resend"
Resend.api_key = "re_xxxxxxxxx"
# Update by contact id
params = {
"id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
"unsubscribed": true,
}
Resend::Contacts.update(params)
# Update by contact email
params = {
"email": "acme@example.com",
"unsubscribed": true,
}
Resend::Contacts.update(params)
package main
import "github.com/resend/resend-go/v4"
func main() {
client := resend.NewClient("re_xxxxxxxxx")
// Update by contact id
params := &resend.UpdateContactRequest{
Id: "e169aa45-1ecf-4183-9955-b1499d5701d3",
Unsubscribed: true,
}
client.Contacts.Update(params)
// Update by contact email
params = &resend.UpdateContactRequest{
Email: "acme@example.com",
Unsubscribed: true,
}
client.Contacts.Update(params)
}
use resend_rs::{types::ContactChanges, Resend, Result};
#[tokio::main]
async fn main() -> Result<()> {
let resend = Resend::new("re_xxxxxxxxx");
let changes = ContactChanges::new().with_unsubscribed(true);
// Update by contact id
let _contact = resend
.contacts
.update("e169aa45-1ecf-4183-9955-b1499d5701d3", changes.clone())
.await?;
// Update by contact email
let _contact = resend
.contacts
.update("acme@example.com", changes)
.await?;
Ok(())
}
import com.resend.Resend;
import com.resend.core.exception.ResendException;
import com.resend.services.contacts.model.UpdateContactOptions;
import com.resend.services.contacts.model.UpdateContactResponseSuccess;
public class Main {
public static void main(String[] args) throws ResendException {
Resend resend = new Resend("re_xxxxxxxxx");
UpdateContactOptions params = UpdateContactOptions.builder()
.id("e169aa45-1ecf-4183-9955-b1499d5701d3") // or: .email("acme@example.com")
.unsubscribed(true)
.build();
UpdateContactResponseSuccess data = resend.contacts().update(params);
}
}
using Resend;
IResend resend = ResendClient.Create( "re_xxxxxxxxx" ); // Or from DI
// By Id
await resend.ContactUpdateAsync(
contactId: new Guid( "e169aa45-1ecf-4183-9955-b1499d5701d3" ),
new ContactData()
{
FirstName = "Stevie",
LastName = "Wozniaks",
IsUnsubscribed = true,
}
);
// By Email
await resend.ContactUpdateByEmailAsync(
"acme@example.com",
new ContactData()
{
FirstName = "Stevie",
LastName = "Wozniaks",
IsUnsubscribed = true,
}
);
# Update by contact id
curl -X PATCH 'https://api.resend.com/contacts/520784e2-887d-4c25-b53c-4ad46ad38100' \
-H 'Authorization: Bearer re_xxxxxxxxx' \
-H 'Content-Type: application/json' \
-d $'{
"unsubscribed": true
}'
# Update by contact email
curl -X PATCH 'https://api.resend.com/contacts/acme@example.com' \
-H 'Authorization: Bearer re_xxxxxxxxx' \
-H 'Content-Type: application/json' \
-d $'{
"unsubscribed": true
}'
# Update by contact id
resend contacts update e169aa45-1ecf-4183-9955-b1499d5701d3 --unsubscribed
# Update by contact email
resend contacts update acme@example.com --unsubscribed
{
"object": "contact",
"id": "479e3145-dd38-476b-932c-529ceb705947"
}