Campayn
campaynCampayn is an email marketing platform that allows users to create, send, and manage email campaigns.
Acciones disponibles (14)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create ContactCAMPAYN_CREATE_CONTACTAcciónTool to create a new contact in a specific list. use when you need to add a contact after gathering details.
CAMPAYN_CREATE_CONTACTAcciónTool to create a new contact in a specific list. use when you need to add a contact after gathering details.
Parámetros de entrada
zipstringZIP or postal code
citystringCity of the contact
emailstringObligatorioContact's email address
sitesobject[]List of website objects for the contact
statestringState or province of the contact
titlestringContact's title or position
phonesobject[]List of phone objects for the contact
socialobject[]List of social account objects for the contact
addressstringMailing address of the contact
companystringCompany name of the contact
countrystringCountry of the contact
list_idintegerObligatorioID of the list to which the contact will be added
last_namestringContact's last name
first_namestringContact's first name
custom_fieldsobject[]List of custom field objects
failOnDuplicatebooleanIf true, the API will return an error when a duplicate contact exists
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ContactCAMPAYN_DELETE_CONTACTAcciónTool to delete a specific contact. use when you need to remove a contact permanently after confirming it should be deleted. example: "delete contact 123".
CAMPAYN_DELETE_CONTACTAcciónTool to delete a specific contact. use when you need to remove a contact permanently after confirming it should be deleted. example: "delete contact 123".
Parámetros de entrada
contact_idintegerObligatorioID of the contact to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ListCAMPAYN_DELETE_LISTAcciónTool to delete a specific contact list. use when cleaning up unused lists after confirming they are no longer needed. example: "delete list 123".
CAMPAYN_DELETE_LISTAcciónTool to delete a specific contact list. use when cleaning up unused lists after confirming they are no longer needed. example: "delete list 123".
Parámetros de entrada
list_idintegerObligatorioID of the contact list to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete webformCAMPAYN_DELETE_WEBFORMAcciónTool to delete a specific webform. use when removing outdated or unnecessary webforms after confirming they are no longer needed. example: "delete webform 123".
CAMPAYN_DELETE_WEBFORMAcciónTool to delete a specific webform. use when removing outdated or unnecessary webforms after confirming they are no longer needed. example: "delete webform 123".
Parámetros de entrada
list_idintegerObligatorioID of the contact list the webform belongs to
webform_idintegerObligatorioID of the webform to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactCAMPAYN_GET_CONTACTAcciónTool to retrieve a specific contact by id. use when you need to fetch full contact details after confirming the contact id.
CAMPAYN_GET_CONTACTAcciónTool to retrieve a specific contact by id. use when you need to fetch full contact details after confirming the contact id.
Parámetros de entrada
contact_idintegerObligatorioID of the contact to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactsCAMPAYN_GET_CONTACTSAcciónTool to retrieve all contacts in a specified list. use when you need to fetch list contacts after confirming list id.
CAMPAYN_GET_CONTACTSAcciónTool to retrieve all contacts in a specified list. use when you need to fetch list contacts after confirming list id.
Parámetros de entrada
list_idintegerObligatorioID of the list to retrieve contacts from.
filter[contact]stringKeyword to filter contacts by name, email, or company.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ListCAMPAYN_GET_LISTAcciónTool to retrieve a specific contact list by id. use when you need to fetch list details like name, tags, and contact count after knowing the list id.
CAMPAYN_GET_LISTAcciónTool to retrieve a specific contact list by id. use when you need to fetch list details like name, tags, and contact count after knowing the list id.
Parámetros de entrada
list_idintegerObligatorioUnique identifier of the contact list to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ListsCAMPAYN_GET_LISTSAcciónTool to retrieve all contact lists. use when you need to fetch available lists before performing list-specific actions. example prompt: "list all my contact lists".
CAMPAYN_GET_LISTSAcciónTool to retrieve all contact lists. use when you need to fetch available lists before performing list-specific actions. example prompt: "list all my contact lists".
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get MessageCAMPAYN_GET_MESSAGEAcciónTool to retrieve details of a specific message by id. use when you need to fetch full message details after confirming the message id.
CAMPAYN_GET_MESSAGEAcciónTool to retrieve details of a specific message by id. use when you need to fetch full message details after confirming the message id.
Parámetros de entrada
message_idintegerObligatorioID of the message to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get MessagesCAMPAYN_GET_MESSAGESAcciónTool to retrieve all email messages. use when you need to list all messages visible to the authenticated user.
CAMPAYN_GET_MESSAGESAcciónTool to retrieve all email messages. use when you need to list all messages visible to the authenticated user.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ReportsCAMPAYN_GET_REPORTSAcciónTool to retrieve report urls and metadata for sent and scheduled emails. use when you need to fetch email delivery data, optionally filtered by a date range (unix timestamp in seconds, utc). note: scheduled emails will have report url set to null.
CAMPAYN_GET_REPORTSAcciónTool to retrieve report urls and metadata for sent and scheduled emails. use when you need to fetch email delivery data, optionally filtered by a date range (unix timestamp in seconds, utc). note: scheduled emails will have report url set to null.
Parámetros de entrada
tointegerEnd date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter 'to'.
from_timeintegerStart date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter 'from'.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WebformCAMPAYN_GET_WEBFORMAcciónTool to retrieve details of a specific webform by id. use after confirming the webform id when you need to fetch form details like title, type, html, and signup count. example: "get webform 1550".
CAMPAYN_GET_WEBFORMAcciónTool to retrieve details of a specific webform by id. use after confirming the webform id when you need to fetch form details like title, type, html, and signup count. example: "get webform 1550".
Parámetros de entrada
list_idintegerObligatorioID of the contact list the webform belongs to
webform_idintegerObligatorioID of the webform to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WebformsCAMPAYN_GET_WEBFORMSAcciónTool to retrieve all webforms for a specific contact list. use when you need to list forms after confirming the list id. example prompt: "list all webforms in list 123".
CAMPAYN_GET_WEBFORMSAcciónTool to retrieve all webforms for a specific contact list. use when you need to list forms after confirming the list id. example prompt: "list all webforms in list 123".
Parámetros de entrada
list_idintegerObligatorioID of the list to retrieve webforms from.
filter[form_type]stringenumFilter forms by type: 0=Signup Page, 1=Embed Signup, 2=WordPress Signup, 3=Facebook Signup.
0123
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ListCAMPAYN_UPDATE_LISTAcciónTool to update a contact list. use after confirming list id and desired changes. example: update list 123 name to 'newsletter subscribers'.
CAMPAYN_UPDATE_LISTAcciónTool to update a contact list. use after confirming list id and desired changes. example: update list 123 name to 'newsletter subscribers'.
Parámetros de entrada
tagsstringComma-separated tags to assign to the list. Omit if not changing tags.
list_idintegerObligatorioID of the contact list to update.
list_namestringNew name for the contact list. Omit if not changing the name.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not