POST /contacts
Create or update a contact by email.
first_name, last_name and unsubscribed are accepted. Properties are typed from their value and auto-created.
Request
The same call in curl, Node and Python. A path id in the sample is a placeholder.
curl
curl -sS -X POST https://api.agentisend.com/contacts \
-H "Authorization: Bearer $AGENTISEND_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"email":"customer@example.com"}'Node
import { AgentiSend } from 'agentisend';
const client = new AgentiSend(process.env.AGENTISEND_API_KEY);
const result = await client.request({
method: 'POST',
path: '/contacts',
body: {
"email": "customer@example.com"
},
});Python
import json, os, urllib.request
url = 'https://api.agentisend.com/contacts'
headers = {'Authorization': 'Bearer ' + os.environ['AGENTISEND_API_KEY']}
payload = json.dumps({"email":"customer@example.com"}).encode()
headers['Content-Type'] = 'application/json'
request = urllib.request.Request(url, data=payload, headers=headers, method='POST')
print(urllib.request.urlopen(request).read().decode())Tag: contacts. Generated from openapi.json; the anchor post-contacts is the id the console's error fix links point at.
Parameters
Idempotency-Keyheader · string · optional — 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-Keyheader · string · optional — Alias of Idempotency-Key. Idempotency-Key wins if both are sent.
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
| audience_id | string | no | A segment on this account. The contact is added to it. A value that is not an audience id is accepted and adds nothing. |
| consent | object | no | Optional consent provenance for this address. Stored, shown and exported; never a reason to refuse. |
| consent.at | string | no | When they agreed, as UTC. Defaults to now. |
| consent.double_opt_in_confirmed_at | string | no | When a confirmation email or click completed double opt-in. |
| consent.ip | string | no | The IP address the agreement was captured from, if known. |
| consent.source | string | yes | Where and how the person agreed — for example "signup form" or "imported list, existing customer". |
| consent.text | string | no | The exact wording they agreed to, if it is on file. |
| string | yes | The contact address. An existing address is updated. | |
| first_name | string | null | no | Given name. Null clears it. |
| last_name | string | null | no | Family name. Null clears it. |
| properties | object | no | Named values stored on the contact. A new name is created. |
| segments | array<object> | no | Segments to add the contact to. Each must be a segment on this account. |
| segments[].id | string | yes | The segment id. |
| status | "active" | "unsubscribed" | no | active, or unsubscribed to stop marketing mail. |
| topics | array<object> | no | Topic subscriptions to record for the contact. Each must be a topic on this account. |
| topics[].id | string | yes | The topic id. |
| topics[].subscription | "opt_in" | "opt_out" | yes | opt_in subscribes the contact. opt_out unsubscribes them. |
| unsubscribed | boolean | no | true stops marketing mail to this address. |
Responses
201— Success400— The request is malformed or a field failed validation. Codes: validation_error, invalid_idempotency_key, invalid_cursor, plan_not_purchasable, stripe_signature_invalid, support_upload_rejected, appsumo_license_not_confirmed, appsumo_ticket_invalid, sign_in_check_required.401— No usable credential was sent. Codes: agent_signup_code_rejected, missing_api_key, session_required, mfa_required, appsumo_signature_invalid.403— The credential may not do this, or the account or key is stopped. Codes: sending_domain_blocked, young_domain_held, domain_sending_disabled, inbound_sender_refused, domain_not_verified, onboarding_recipient_not_a_member, onboarding_sender_unavailable, account_suspended, account_sandboxed, agent_unconfirmed, recipient_ramp, human_action_required, csrf_origin_rejected, charge_not_this_account, invalid_api_key, restricted_api_key, insufficient_role, invite_email_mismatch, domain_scope_violation, dedicated_ip_assigned_by_us, approval_required, staff_review_required, trust_paused, kill_switch_active.409— The request conflicts with the current state. Codes: domain_already_exists, template_name_taken, template_alias_taken, template_in_use, segment_in_use, contact_resubscribe_required, email_still_scheduled, domain_verified_elsewhere, domain_not_claimable, return_path_subdomain_in_use, overage_not_on_plan, term_not_on_sale, subscription_active, portal_change_unavailable, already_in_account, idempotency_in_flight, idempotency_payload_mismatch, approval_expired, support_closed, support_reopen_expired, support_merge_conflict, support_reply_too_soon, appsumo_license_linked, appsumo_license_inactive, lifetime_sold_on_appsumo.413— The request body is larger than this operation accepts. Codes: payload_too_large, support_upload_too_large.415— The request body is not JSON. Codes: unsupported_media_type.429— A rate, quota or ramp ceiling was reached. Codes: onboarding_daily_cap_reached, trust_throttled, invite_limit_reached, rate_ceiling_exceeded, daily_quota_exceeded, monthly_quota_exceeded, rate_limit_exceeded, support_rate_limited, appsumo_lookup_limited.500— Something failed on our side. Codes: internal_server_error.
Response headers
ratelimit-limit— Messages this API key may spend in one 60-second window.ratelimit-remaining— Messages left in the current window.ratelimit-reset— Seconds until the current window resets and the budget refills.
201 body
| Field | Type | Required | Notes |
|---|---|---|---|
| consent | object | yes | |
| consent.at | string | null | yes | |
| consent.double_opt_in_confirmed_at | string | null | yes | |
| consent.ip | string | null | yes | |
| consent.source | string | null | yes | |
| consent.text | string | null | yes | |
| created_at | string | yes | |
| string | yes | ||
| first_name | string | null | yes | |
| id | string | yes | |
| last_name | string | null | yes | |
| object | string | yes | |
| properties | object | yes | |
| property_types | object | yes | |
| status | string | yes | |
| unsubscribed | boolean | yes | |
| updated_at | string | yes |
Response example
201
{
"consent": {
"at": "2026-09-04T09:14:00.000Z",
"double_opt_in_confirmed_at": "2026-09-04T09:14:00.000Z",
"ip": "example",
"source": "example",
"text": "example"
},
"created_at": "2026-09-04T09:14:00.000Z",
"email": "example",
"first_name": "example",
"id": "9c8f8f0e-3d1a-4d3f-9a1e-2b7c1a0f5e42",
"last_name": "example",
"object": "contact",
"properties": {},
"property_types": {},
"status": "example",
"unsubscribed": false,
"updated_at": "2026-09-04T09:14:00.000Z"
}Errors
The codes this operation can answer with, and what to do about each. Every one arrives with its code, message, fix and docs_url.
contact_resubscribe_required(409) — This address asked not to be contacted, so marking the contact active leaves that in place. Fix: POST /contacts/:id/resubscribe with consent_source and consent_at after the person opts back in. The id can be the contact id or the email address. A spam report is not lifted by that call.csrf_origin_rejected(403) — This request came from a page on another site, and it changes data. Fix: Call the API with an API key (Authorization: Bearer …) instead of a session cookie, or make the request from the console. Create a key in the console under Settings, API keys.idempotency_in_flight(409) — A request with this Idempotency-Key is still in progress. Fix: Wait and retry with the same Idempotency-Key to receive the original response.idempotency_payload_mismatch(409) — Same Idempotency-Key was used with a different payload. Fix: Reuse the exact same body for retries, or send a new Idempotency-Key for a new request.insufficient_role(403) — Your role on this account cannot make this change. Fix: Ask an owner to make the change, or to raise your role with PATCH /team/members/:id.internal_server_error(500, internal_server_error) — Unexpected error. Fix: Retry ONCE after a short pause, with the same Idempotency-Key so the retry cannot double-send. If it fails again, stop retrying and report the x-request-id from the response — that id is what identifies this exact failure in support.invalid_api_key(403, invalid_api_key) — API key is invalid or revoked. Fix: Create a new key with POST /api-keys; deleted keys cannot be restored.invalid_idempotency_key(400) — Idempotency-Key must be 1-256 characters. Fix: Send a non-empty Idempotency-Key header of at most 256 characters.mfa_required(401) — This session has not completed two-factor authentication. Fix: Finish signing in at https://console.agentisend.com/verify with a code from your authenticator app, or one of your recovery codes. Manage the second factor in the console under Settings, Security.missing_api_key(401, missing_api_key) — Missing API key in authorization header. Fix: Create an API key at https://console.agentisend.com/api-keys and send "Authorization: Bearer as_...". MCP clients can connect with OAuth instead of a key.payload_too_large(413) — Request body is larger than this endpoint accepts. Fix: Send a smaller body. Most endpoints accept 1 MB. Sends (POST /emails, /emails/batch, replies) and template, broadcast and automation edits accept 50 MB, which fits 40 MB of attachments after base64. /mcp accepts 1 MB per JSON-RPC call.rate_limit_exceeded(429, rate_ceiling_exceeded, rate_limit_exceeded) — Too many requests. Fix: Back off and retry honoring the Retry-After header.restricted_api_key(403, restricted_api_key) — This API key is restricted to sending only. Fix: Use a full_access key (POST /api-keys with permission=full_access) for management endpoints.unsupported_media_type(415) — This endpoint does not accept that content type. Fix: Send the body as JSON with `Content-Type: application/json`.validation_error(400, domain_not_verified, invalid_parameter, validation_error) — Error in one or more fields. Fix: Correct the fields listed in the error details and retry the request.