/resend-management | Type: Application | PCID required: Yes
Tools
resend_management_delete_api_keys_by_api_key_id
Remove an existing API key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
api_key_id | string | Yes | — | The API key ID. |
resend_management_delete_contact_properties_by_id
Remove an existing contact property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Contact Property ID. |
resend_management_delete_contacts_by_contact_id_segments_by_segment_id
Remove a contact from a segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact_id | string | Yes | — | The Contact ID or email address. |
segment_id | string | Yes | — | The Segment ID. |
resend_management_delete_contacts_by_id
Remove an existing contact by ID or email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Contact ID or email address. |
resend_management_delete_domains_by_domain_id
Remove an existing domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain_id | string | Yes | — | The ID of the domain. |
resend_management_delete_segments_by_id
Remove an existing segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Segment ID. |
resend_management_delete_topics_by_id
Remove an existing topic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Topic ID. |
resend_management_delete_webhooks_by_webhook_id
Remove an existing webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | The Webhook ID. |
resend_management_get_api_keys
Retrieve a list of API keys Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_management_get_contact_properties
Retrieve a list of contact properties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_management_get_contact_properties_by_id
Retrieve a single contact property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Contact Property ID. |
resend_management_get_contacts
Retrieve a list of contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
segment_id | string | No | — | Filter contacts by segment ID. |
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_management_get_contacts_by_contact_id_segments
Retrieve a list of segments for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact_id | string | Yes | — | The Contact ID or email address. |
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_management_get_contacts_by_contact_id_topics
Retrieve topics for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact_id | string | Yes | — | The Contact ID or email address. |
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_management_get_contacts_by_id
Retrieve a single contact by ID or email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Contact ID or email address. |
resend_management_get_domains
Retrieve a list of domains Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_management_get_domains_by_domain_id
Retrieve a single domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain_id | string | Yes | — | The ID of the domain. |
resend_management_get_segments
Retrieve a list of segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_management_get_segments_by_id
Retrieve a single segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Segment ID. |
resend_management_get_topics
Retrieve a list of topics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return. |
after | string | No | — | Return items after this cursor. |
before | string | No | — | Return items before this cursor. |
resend_management_get_topics_by_id
Retrieve a single topic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Topic ID. |
resend_management_get_webhooks
Retrieve a list of webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of webhooks to return. |
after | string | No | — | Pagination cursor to fetch results after this webhook ID. Cannot be used with ‘before’. |
before | string | No | — | Pagination cursor to fetch results before this webhook ID. Cannot be used with ‘after’. |
resend_management_get_webhooks_by_webhook_id
Retrieve a single webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | The Webhook ID. |
resend_management_patch_contact_properties_by_id
Update an existing contact property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Contact Property ID. |
fallback_value | object | No | — | The default value to use when the property is not set for a contact. Must match the type of the property. |
resend_management_patch_contacts_by_contact_id_topics
Update topics for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact_id | string | Yes | — | The Contact ID or email address. |
topics | object[] | Yes | — | The topics value |
resend_management_patch_contacts_by_id
Update a single contact by ID or email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Contact ID or email address. |
email | string | No | — | Email address of the contact. |
first_name | string | No | — | First name of the contact. |
last_name | string | No | — | Last name of the contact. |
properties | object | No | — | A map of custom property keys and values to update. |
unsubscribed | boolean | No | — | The Contact’s global subscription status. If set to true, the contact will be unsubscribed from all Broadcasts. |
resend_management_patch_domains_by_domain_id
Update an existing domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain_id | string | Yes | — | The ID of the domain. |
capabilities | object | No | — | Configure the domain capabilities for sending and receiving emails. At least one capability must be enabled. |
click_tracking | boolean | No | — | Track clicks within the body of each HTML email. |
open_tracking | boolean | No | — | Track the open rate of each email. |
tls | string | No | — | enforced | opportunistic. |
tracking_subdomain | string | No | — | The subdomain to use for click and open tracking. |
resend_management_patch_topics_by_id
Update an existing topic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Topic ID. |
description | string | No | — | A description of the topic. Max 200 characters. |
name | string | No | — | The name of the topic. Max 50 characters. |
visibility | string | No | — | The visibility of the topic. |
resend_management_patch_webhooks_by_webhook_id
Update an existing webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | The Webhook ID. |
endpoint | string | No | — | The URL where webhook events will be sent. |
events | string[] | No | — | Array of event types to subscribe to. |
status | string | No | — | The status of the webhook. |
resend_management_post_api_keys
Create a new API key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain_id | string | No | — | Restrict an API key to send emails only from a specific domain. Only used when the permission is sending_access. |
name | string | Yes | — | The API key name. |
permission | string | No | — | The API key can have full access to Resend’s API or be only restricted to send emails. * full_access - Can create, delete, get, and update any resource. * sending_access - Can only send emails. |
resend_management_post_contact_properties
Create a new contact property Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fallback_value | object | No | — | The default value to use when the property is not set for a contact. Must match the type specified in the type field. |
key | string | Yes | — | The property key. Max length is 50 characters. Only alphanumeric characters and underscores are allowed. |
type | string | Yes | — | The property type. |
resend_management_post_contacts
Create a new contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audience_id | string | No | — | Unique identifier of the audience to which the contact belongs. |
email | string | Yes | — | Email address of the contact. |
first_name | string | No | — | First name of the contact. |
last_name | string | No | — | Last name of the contact. |
properties | object | No | — | A map of custom property keys and values to create. |
segments | string[] | No | — | Array of segment IDs to add the contact to. |
topics | object[] | No | — | Array of topic subscriptions for the contact. |
unsubscribed | boolean | No | — | The Contact’s global subscription status. If set to true, the contact will be unsubscribed from all Broadcasts. |
resend_management_post_contacts_by_contact_id_segments_by_segment_id
Add a contact to a segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact_id | string | Yes | — | The Contact ID or email address. |
segment_id | string | Yes | — | The Segment ID. |
resend_management_post_domains
Create a new domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
capabilities | object | No | — | Configure the domain capabilities for sending and receiving emails. At least one capability must be enabled. |
click_tracking | boolean | No | — | Track clicks within the body of each HTML email. |
custom_return_path | string | No | — | For advanced use cases, choose a subdomain for the Return-Path address. Defaults to ‘send’ (i.e., send.yourdomain.tld). |
name | string | Yes | — | The name of the domain you want to create. |
open_tracking | boolean | No | — | Track the open rate of each email. |
region | string | No | — | The region where emails will be sent from. Possible values are us-east-1 | eu-west-1 | sa-east-1 | ap-northeast-1 |
tls | string | No | — | TLS mode. Opportunistic attempts secure connection but falls back to unencrypted. Enforced requires TLS or email won’t be sent. |
tracking_subdomain | string | No | — | The subdomain to use for click and open tracking. |
resend_management_post_domains_by_domain_id_verify
Verify an existing domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain_id | string | Yes | — | The ID of the domain. |
resend_management_post_segments
Create a new segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
audience_id | string | No | — | The ID of the audience this segment belongs to. |
filter | object | No | — | Filter conditions for the segment. |
name | string | Yes | — | The name of the segment. |
resend_management_post_topics
Create a new topic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
default_subscription | string | Yes | — | The default subscription status for the topic. Cannot be changed after creation. |
description | string | No | — | A description of the topic. Max 200 characters. |
name | string | Yes | — | The name of the topic. Max 50 characters. |
visibility | string | No | — | The visibility of the topic. Public topics are visible to all contacts on the unsubscribe page. Private topics are only visible to opted-in contacts. |
resend_management_post_webhooks
Create a new webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint | string | Yes | — | The URL where webhook events will be sent. |
events | string[] | Yes | — | Array of event types to subscribe to. |
resend_management_verify_domain
Verify an existing domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain_id | string | Yes | — | The ID of the domain. |

