/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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"api_key_id": {
"type": "string",
"description": "The API key ID."
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Contact Property ID."
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contact_id": {
"type": "string",
"description": "The Contact ID or email address."
},
"segment_id": {
"type": "string",
"description": "The Segment ID."
}
},
"required": [
"PCID",
"contact_id",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Contact ID or email address."
}
},
"required": [
"PCID",
"id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domain_id": {
"type": "string",
"description": "The ID of the domain."
}
},
"required": [
"PCID",
"domain_id"
]
}
resend_management_delete_segments_by_id
Remove an existing segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Segment ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Segment ID."
}
},
"required": [
"PCID",
"id"
]
}
resend_management_delete_topics_by_id
Remove an existing topic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Topic ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Topic ID."
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_id": {
"type": "string",
"description": "The Webhook ID."
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of items to return."
},
"after": {
"type": "string",
"description": "Return items after this cursor."
},
"before": {
"type": "string",
"description": "Return items before this cursor."
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of items to return."
},
"after": {
"type": "string",
"description": "Return items after this cursor."
},
"before": {
"type": "string",
"description": "Return items before this cursor."
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Contact Property ID."
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"segment_id": {
"type": "string",
"description": "Filter contacts by segment ID."
},
"limit": {
"type": "integer",
"description": "Number of items to return."
},
"after": {
"type": "string",
"description": "Return items after this cursor."
},
"before": {
"type": "string",
"description": "Return items before this cursor."
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contact_id": {
"type": "string",
"description": "The Contact ID or email address."
},
"limit": {
"type": "integer",
"description": "Number of items to return."
},
"after": {
"type": "string",
"description": "Return items after this cursor."
},
"before": {
"type": "string",
"description": "Return items before this cursor."
}
},
"required": [
"PCID",
"contact_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contact_id": {
"type": "string",
"description": "The Contact ID or email address."
},
"limit": {
"type": "integer",
"description": "Number of items to return."
},
"after": {
"type": "string",
"description": "Return items after this cursor."
},
"before": {
"type": "string",
"description": "Return items before this cursor."
}
},
"required": [
"PCID",
"contact_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Contact ID or email address."
}
},
"required": [
"PCID",
"id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of items to return."
},
"after": {
"type": "string",
"description": "Return items after this cursor."
},
"before": {
"type": "string",
"description": "Return items before this cursor."
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domain_id": {
"type": "string",
"description": "The ID of the domain."
}
},
"required": [
"PCID",
"domain_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of items to return."
},
"after": {
"type": "string",
"description": "Return items after this cursor."
},
"before": {
"type": "string",
"description": "Return items before this cursor."
}
},
"required": [
"PCID"
]
}
resend_management_get_segments_by_id
Retrieve a single segment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Segment ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Segment ID."
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of items to return."
},
"after": {
"type": "string",
"description": "Return items after this cursor."
},
"before": {
"type": "string",
"description": "Return items before this cursor."
}
},
"required": [
"PCID"
]
}
resend_management_get_topics_by_id
Retrieve a single topic Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The Topic ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Topic ID."
}
},
"required": [
"PCID",
"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’. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Maximum number of webhooks to return."
},
"after": {
"type": "string",
"description": "Pagination cursor to fetch results after this webhook ID. Cannot be used with 'before'."
},
"before": {
"type": "string",
"description": "Pagination cursor to fetch results before this webhook ID. Cannot be used with 'after'."
}
},
"required": [
"PCID"
]
}
resend_management_get_webhooks_by_webhook_id
Retrieve a single webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | The Webhook ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_id": {
"type": "string",
"description": "The Webhook ID."
}
},
"required": [
"PCID",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Contact Property ID."
},
"fallback_value": {
"description": "The default value to use when the property is not set for a contact. Must match the type of the property."
}
},
"required": [
"PCID",
"id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contact_id": {
"type": "string",
"description": "The Contact ID or email address."
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the topic."
},
"subscription": {
"type": "string",
"enum": [
"opt_in",
"opt_out"
],
"description": "The subscription status (opt_in or opt_out)."
}
}
},
"description": "The topics value"
}
},
"required": [
"PCID",
"contact_id",
"topics"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Contact ID or email address."
},
"email": {
"type": "string",
"description": "Email address of the contact."
},
"first_name": {
"type": "string",
"description": "First name of the contact."
},
"last_name": {
"type": "string",
"description": "Last name of the contact."
},
"properties": {
"type": "object",
"description": "A map of custom property keys and values to update."
},
"unsubscribed": {
"type": "boolean",
"description": "The Contact's global subscription status. If set to true, the contact will be unsubscribed from all Broadcasts."
}
},
"required": [
"PCID",
"id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domain_id": {
"type": "string",
"description": "The ID of the domain."
},
"capabilities": {
"type": "object",
"description": "Configure the domain capabilities for sending and receiving emails. At least one capability must be enabled.",
"properties": {
"sending": {
"type": "string",
"description": "Enable or disable sending emails from this domain.",
"enum": [
"enabled",
"disabled"
]
},
"receiving": {
"type": "string",
"description": "Enable or disable receiving emails to this domain.",
"enum": [
"enabled",
"disabled"
]
}
}
},
"click_tracking": {
"type": "boolean",
"description": "Track clicks within the body of each HTML email."
},
"open_tracking": {
"type": "boolean",
"description": "Track the open rate of each email."
},
"tls": {
"type": "string",
"description": "enforced | opportunistic."
},
"tracking_subdomain": {
"type": "string",
"description": "The subdomain to use for click and open tracking."
}
},
"required": [
"PCID",
"domain_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The Topic ID."
},
"description": {
"type": "string",
"description": "A description of the topic. Max 200 characters."
},
"name": {
"type": "string",
"description": "The name of the topic. Max 50 characters."
},
"visibility": {
"type": "string",
"description": "The visibility of the topic.",
"enum": [
"public",
"private"
]
}
},
"required": [
"PCID",
"id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_id": {
"type": "string",
"description": "The Webhook ID."
},
"endpoint": {
"type": "string",
"description": "The URL where webhook events will be sent."
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of event types to subscribe to."
},
"status": {
"type": "string",
"description": "The status of the webhook.",
"enum": [
"enabled",
"disabled"
]
}
},
"required": [
"PCID",
"webhook_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domain_id": {
"type": "string",
"description": "Restrict an API key to send emails only from a specific domain. Only used when the permission is sending_access."
},
"name": {
"type": "string",
"description": "The API key name."
},
"permission": {
"type": "string",
"description": "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.",
"enum": [
"full_access",
"sending_access"
]
}
},
"required": [
"PCID",
"name"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fallback_value": {
"description": "The default value to use when the property is not set for a contact. Must match the type specified in the type field."
},
"key": {
"type": "string",
"description": "The property key. Max length is 50 characters. Only alphanumeric characters and underscores are allowed."
},
"type": {
"type": "string",
"description": "The property type.",
"enum": [
"string",
"number"
]
}
},
"required": [
"PCID",
"key",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"audience_id": {
"type": "string",
"description": "Unique identifier of the audience to which the contact belongs."
},
"email": {
"type": "string",
"description": "Email address of the contact."
},
"first_name": {
"type": "string",
"description": "First name of the contact."
},
"last_name": {
"type": "string",
"description": "Last name of the contact."
},
"properties": {
"type": "object",
"description": "A map of custom property keys and values to create."
},
"segments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of segment IDs to add the contact to."
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The topic ID."
},
"subscription": {
"type": "string",
"enum": [
"opt_in",
"opt_out"
],
"description": "The subscription status for this topic."
}
}
},
"description": "Array of topic subscriptions for the contact."
},
"unsubscribed": {
"type": "boolean",
"description": "The Contact's global subscription status. If set to true, the contact will be unsubscribed from all Broadcasts."
}
},
"required": [
"PCID",
"email"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contact_id": {
"type": "string",
"description": "The Contact ID or email address."
},
"segment_id": {
"type": "string",
"description": "The Segment ID."
}
},
"required": [
"PCID",
"contact_id",
"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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"capabilities": {
"type": "object",
"description": "Configure the domain capabilities for sending and receiving emails. At least one capability must be enabled.",
"properties": {
"sending": {
"type": "string",
"description": "Enable or disable sending emails from this domain.",
"enum": [
"enabled",
"disabled"
]
},
"receiving": {
"type": "string",
"description": "Enable or disable receiving emails to this domain.",
"enum": [
"enabled",
"disabled"
]
}
}
},
"click_tracking": {
"type": "boolean",
"description": "Track clicks within the body of each HTML email."
},
"custom_return_path": {
"type": "string",
"description": "For advanced use cases, choose a subdomain for the Return-Path address. Defaults to 'send' (i.e., send.yourdomain.tld)."
},
"name": {
"type": "string",
"description": "The name of the domain you want to create."
},
"open_tracking": {
"type": "boolean",
"description": "Track the open rate of each email."
},
"region": {
"type": "string",
"description": "The region where emails will be sent from. Possible values are us-east-1 | eu-west-1 | sa-east-1 | ap-northeast-1",
"enum": [
"us-east-1",
"eu-west-1",
"sa-east-1",
"ap-northeast-1"
]
},
"tls": {
"type": "string",
"description": "TLS mode. Opportunistic attempts secure connection but falls back to unencrypted. Enforced requires TLS or email won't be sent.",
"enum": [
"opportunistic",
"enforced"
]
},
"tracking_subdomain": {
"type": "string",
"description": "The subdomain to use for click and open tracking."
}
},
"required": [
"PCID",
"name"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domain_id": {
"type": "string",
"description": "The ID of the domain."
}
},
"required": [
"PCID",
"domain_id"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"audience_id": {
"type": "string",
"description": "The ID of the audience this segment belongs to."
},
"filter": {
"type": "object",
"description": "Filter conditions for the segment."
},
"name": {
"type": "string",
"description": "The name of the segment."
}
},
"required": [
"PCID",
"name"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"default_subscription": {
"type": "string",
"description": "The default subscription status for the topic. Cannot be changed after creation.",
"enum": [
"opt_in",
"opt_out"
]
},
"description": {
"type": "string",
"description": "A description of the topic. Max 200 characters."
},
"name": {
"type": "string",
"description": "The name of the topic. Max 50 characters."
},
"visibility": {
"type": "string",
"description": "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.",
"enum": [
"public",
"private"
]
}
},
"required": [
"PCID",
"default_subscription",
"name"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"endpoint": {
"type": "string",
"description": "The URL where webhook events will be sent."
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of event types to subscribe to."
}
},
"required": [
"PCID",
"endpoint",
"events"
]
}
resend_management_verify_domain
Verify an existing domain Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain_id | string | Yes | — | The ID of the domain. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"domain_id": {
"type": "string",
"description": "The ID of the domain."
}
},
"required": [
"PCID",
"domain_id"
]
}

