contacts

Edit one contact by id or email.

first_name, last_name and unsubscribed are accepted. Properties merge; null removes one.

patch/contacts/{id}

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/contacts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Makes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request). Resend-Idempotency-Key is accepted as the same header.

Resend-Idempotency-Keystring

Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Request body

emailstring email

A new address for this contact.

first_namestring nullable

Given name. Null clears it.

last_namestring nullable

Family name. Null clears it.

unsubscribedboolean

true stops marketing mail to this address.

status'active' | 'unsubscribed'

active, or unsubscribed to stop marketing mail.

propertiesobject

Values to merge. Null removes that property.

Response

Success

object'contact' required
idstring uuid required
emailstring required
statusstring required
first_namestring nullable required
last_namestring nullable required
unsubscribedboolean required
propertiesobject required
property_typesobject required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.