Resend API (unofficial showcase)
POST/contacts

Create a contact

Creates a contact with an email address and optional profile, subscription, and grouping details. Include email; you can also set custom properties, add segments, or configure topics.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

8 body fields

Contact details to create. Include email; other fields provide optional profile, subscription, and grouping information.

emailstringrequired
Email address of the contact.
first_namestringoptional
First name of the contact.
last_namestringoptional
Last name of the contact.
unsubscribedbooleanoptional
The Contact's global subscription status. If set to true, the contact will be unsubscribed from all Broadcasts.
propertiesobjectoptional
A map of custom property keys and values to create.
segmentsarray<object>optional
Array of segment IDs to add the contact to.
topicsarray<object>optional
Array of topic subscriptions for the contact.
audience_idstringdeprecatedoptional
Unique identifier of the audience to which the contact belongs.

1 status code
201Returns the created contact's identifier and the response object type.
objectstringoptional
Type of the response object.
idstringoptional
Unique identifier for the created contact.

Error handling

email is required. For each topic subscription, subscription must be opt_in or opt_out; custom property values must be strings, numbers, or null.