{ "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" ]}
{ "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" ]}
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
{ "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" ]}
The default value to use when the property is not set for a contact. Must match the type of the property.
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" ]}
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
{ "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" ]}
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
{ "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." }, "receiving": { "type": "string", "description": "Enable or disable receiving emails to this domain." } } }, "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" ]}
{ "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" ]}
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
{ "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" ]}
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
{ "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" ]}
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
{ "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" }, "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" ]}
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
{ "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." }, "receiving": { "type": "string", "description": "Enable or disable receiving emails to this domain." } } }, "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" ]}
{ "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" ]}
{ "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" ]}
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
{ "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" ]}
{ "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" ]}