Skip to main content
Server path: /resend-management | Type: Application | PCID required: Yes

Tools

ToolDescription
resend_management_delete_api_keys_by_api_key_idRemove an existing API key
resend_management_delete_contact_properties_by_idRemove an existing contact property
resend_management_delete_contacts_by_contact_id_segments_by_segment_idRemove a contact from a segment
resend_management_delete_contacts_by_idRemove an existing contact by ID or email
resend_management_delete_domains_by_domain_idRemove an existing domain
resend_management_delete_segments_by_idRemove an existing segment
resend_management_delete_topics_by_idRemove an existing topic
resend_management_delete_webhooks_by_webhook_idRemove an existing webhook
resend_management_get_api_keysRetrieve a list of API keys
resend_management_get_contact_propertiesRetrieve a list of contact properties
resend_management_get_contact_properties_by_idRetrieve a single contact property
resend_management_get_contactsRetrieve a list of contacts
resend_management_get_contacts_by_contact_id_segmentsRetrieve a list of segments for a contact
resend_management_get_contacts_by_contact_id_topicsRetrieve topics for a contact
resend_management_get_contacts_by_idRetrieve a single contact by ID or email
resend_management_get_domainsRetrieve a list of domains
resend_management_get_domains_by_domain_idRetrieve a single domain
resend_management_get_segmentsRetrieve a list of segments
resend_management_get_segments_by_idRetrieve a single segment
resend_management_get_topicsRetrieve a list of topics
resend_management_get_topics_by_idRetrieve a single topic
resend_management_get_webhooksRetrieve a list of webhooks
resend_management_get_webhooks_by_webhook_idRetrieve a single webhook
resend_management_patch_contact_properties_by_idUpdate an existing contact property
resend_management_patch_contacts_by_contact_id_topicsUpdate topics for a contact
resend_management_patch_contacts_by_idUpdate a single contact by ID or email
resend_management_patch_domains_by_domain_idUpdate an existing domain
resend_management_patch_topics_by_idUpdate an existing topic
resend_management_patch_webhooks_by_webhook_idUpdate an existing webhook
resend_management_post_api_keysCreate a new API key
resend_management_post_contact_propertiesCreate a new contact property
resend_management_post_contactsCreate a new contact
resend_management_post_contacts_by_contact_id_segments_by_segment_idAdd a contact to a segment
resend_management_post_domainsCreate a new domain
resend_management_post_domains_by_domain_id_verifyVerify an existing domain
resend_management_post_segmentsCreate a new segment
resend_management_post_topicsCreate a new topic
resend_management_post_webhooksCreate a new webhook
resend_management_verify_domainVerify an existing domain

resend_management_delete_api_keys_by_api_key_id

Remove an existing API key Parameters:
ParameterTypeRequiredDefaultDescription
api_key_idstringYesThe API key ID.

resend_management_delete_contact_properties_by_id

Remove an existing contact property Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Contact Property ID.

resend_management_delete_contacts_by_contact_id_segments_by_segment_id

Remove a contact from a segment Parameters:
ParameterTypeRequiredDefaultDescription
contact_idstringYesThe Contact ID or email address.
segment_idstringYesThe Segment ID.

resend_management_delete_contacts_by_id

Remove an existing contact by ID or email Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Contact ID or email address.

resend_management_delete_domains_by_domain_id

Remove an existing domain Parameters:
ParameterTypeRequiredDefaultDescription
domain_idstringYesThe ID of the domain.

resend_management_delete_segments_by_id

Remove an existing segment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Segment ID.

resend_management_delete_topics_by_id

Remove an existing topic Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Topic ID.

resend_management_delete_webhooks_by_webhook_id

Remove an existing webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idstringYesThe Webhook ID.

resend_management_get_api_keys

Retrieve a list of API keys Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of items to return.
afterstringNoReturn items after this cursor.
beforestringNoReturn items before this cursor.

resend_management_get_contact_properties

Retrieve a list of contact properties Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of items to return.
afterstringNoReturn items after this cursor.
beforestringNoReturn items before this cursor.

resend_management_get_contact_properties_by_id

Retrieve a single contact property Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Contact Property ID.

resend_management_get_contacts

Retrieve a list of contacts Parameters:
ParameterTypeRequiredDefaultDescription
segment_idstringNoFilter contacts by segment ID.
limitintegerNoNumber of items to return.
afterstringNoReturn items after this cursor.
beforestringNoReturn items before this cursor.

resend_management_get_contacts_by_contact_id_segments

Retrieve a list of segments for a contact Parameters:
ParameterTypeRequiredDefaultDescription
contact_idstringYesThe Contact ID or email address.
limitintegerNoNumber of items to return.
afterstringNoReturn items after this cursor.
beforestringNoReturn items before this cursor.

resend_management_get_contacts_by_contact_id_topics

Retrieve topics for a contact Parameters:
ParameterTypeRequiredDefaultDescription
contact_idstringYesThe Contact ID or email address.
limitintegerNoNumber of items to return.
afterstringNoReturn items after this cursor.
beforestringNoReturn items before this cursor.

resend_management_get_contacts_by_id

Retrieve a single contact by ID or email Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Contact ID or email address.

resend_management_get_domains

Retrieve a list of domains Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of items to return.
afterstringNoReturn items after this cursor.
beforestringNoReturn items before this cursor.

resend_management_get_domains_by_domain_id

Retrieve a single domain Parameters:
ParameterTypeRequiredDefaultDescription
domain_idstringYesThe ID of the domain.

resend_management_get_segments

Retrieve a list of segments Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of items to return.
afterstringNoReturn items after this cursor.
beforestringNoReturn items before this cursor.

resend_management_get_segments_by_id

Retrieve a single segment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Segment ID.

resend_management_get_topics

Retrieve a list of topics Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of items to return.
afterstringNoReturn items after this cursor.
beforestringNoReturn items before this cursor.

resend_management_get_topics_by_id

Retrieve a single topic Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Topic ID.

resend_management_get_webhooks

Retrieve a list of webhooks Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoMaximum number of webhooks to return.
afterstringNoPagination cursor to fetch results after this webhook ID. Cannot be used with ‘before’.
beforestringNoPagination 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:
ParameterTypeRequiredDefaultDescription
webhook_idstringYesThe Webhook ID.

resend_management_patch_contact_properties_by_id

Update an existing contact property Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Contact Property ID.
fallback_valueobjectNoThe 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:
ParameterTypeRequiredDefaultDescription
contact_idstringYesThe Contact ID or email address.
topicsobject[]YesThe topics value

resend_management_patch_contacts_by_id

Update a single contact by ID or email Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Contact ID or email address.
emailstringNoEmail address of the contact.
first_namestringNoFirst name of the contact.
last_namestringNoLast name of the contact.
propertiesobjectNoA map of custom property keys and values to update.
unsubscribedbooleanNoThe 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:
ParameterTypeRequiredDefaultDescription
domain_idstringYesThe ID of the domain.
capabilitiesobjectNoConfigure the domain capabilities for sending and receiving emails. At least one capability must be enabled.
click_trackingbooleanNoTrack clicks within the body of each HTML email.
open_trackingbooleanNoTrack the open rate of each email.
tlsstringNoenforced | opportunistic.
tracking_subdomainstringNoThe subdomain to use for click and open tracking.

resend_management_patch_topics_by_id

Update an existing topic Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe Topic ID.
descriptionstringNoA description of the topic. Max 200 characters.
namestringNoThe name of the topic. Max 50 characters.
visibilitystringNoThe visibility of the topic.

resend_management_patch_webhooks_by_webhook_id

Update an existing webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idstringYesThe Webhook ID.
endpointstringNoThe URL where webhook events will be sent.
eventsstring[]NoArray of event types to subscribe to.
statusstringNoThe status of the webhook.

resend_management_post_api_keys

Create a new API key Parameters:
ParameterTypeRequiredDefaultDescription
domain_idstringNoRestrict an API key to send emails only from a specific domain. Only used when the permission is sending_access.
namestringYesThe API key name.
permissionstringNoThe 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:
ParameterTypeRequiredDefaultDescription
fallback_valueobjectNoThe default value to use when the property is not set for a contact. Must match the type specified in the type field.
keystringYesThe property key. Max length is 50 characters. Only alphanumeric characters and underscores are allowed.
typestringYesThe property type.

resend_management_post_contacts

Create a new contact Parameters:
ParameterTypeRequiredDefaultDescription
audience_idstringNoUnique identifier of the audience to which the contact belongs.
emailstringYesEmail address of the contact.
first_namestringNoFirst name of the contact.
last_namestringNoLast name of the contact.
propertiesobjectNoA map of custom property keys and values to create.
segmentsstring[]NoArray of segment IDs to add the contact to.
topicsobject[]NoArray of topic subscriptions for the contact.
unsubscribedbooleanNoThe 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:
ParameterTypeRequiredDefaultDescription
contact_idstringYesThe Contact ID or email address.
segment_idstringYesThe Segment ID.

resend_management_post_domains

Create a new domain Parameters:
ParameterTypeRequiredDefaultDescription
capabilitiesobjectNoConfigure the domain capabilities for sending and receiving emails. At least one capability must be enabled.
click_trackingbooleanNoTrack clicks within the body of each HTML email.
custom_return_pathstringNoFor advanced use cases, choose a subdomain for the Return-Path address. Defaults to ‘send’ (i.e., send.yourdomain.tld).
namestringYesThe name of the domain you want to create.
open_trackingbooleanNoTrack the open rate of each email.
regionstringNoThe region where emails will be sent from. Possible values are us-east-1 | eu-west-1 | sa-east-1 | ap-northeast-1
tlsstringNoTLS mode. Opportunistic attempts secure connection but falls back to unencrypted. Enforced requires TLS or email won’t be sent.
tracking_subdomainstringNoThe subdomain to use for click and open tracking.

resend_management_post_domains_by_domain_id_verify

Verify an existing domain Parameters:
ParameterTypeRequiredDefaultDescription
domain_idstringYesThe ID of the domain.

resend_management_post_segments

Create a new segment Parameters:
ParameterTypeRequiredDefaultDescription
audience_idstringNoThe ID of the audience this segment belongs to.
filterobjectNoFilter conditions for the segment.
namestringYesThe name of the segment.

resend_management_post_topics

Create a new topic Parameters:
ParameterTypeRequiredDefaultDescription
default_subscriptionstringYesThe default subscription status for the topic. Cannot be changed after creation.
descriptionstringNoA description of the topic. Max 200 characters.
namestringYesThe name of the topic. Max 50 characters.
visibilitystringNoThe 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:
ParameterTypeRequiredDefaultDescription
endpointstringYesThe URL where webhook events will be sent.
eventsstring[]YesArray of event types to subscribe to.

resend_management_verify_domain

Verify an existing domain Parameters:
ParameterTypeRequiredDefaultDescription
domain_idstringYesThe ID of the domain.