NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Campayn connects to a Nagent workspace with an API key. Once it is connected, agents can call 14 Campayn actions, such as "Create Contact", "Get Contact" and "Get Contacts". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Campayn, with input parameters and output schema.
CAMPAYN_CREATE_CONTACTTool to create a new contact in a specific list. Use when you need to add a contact after gathering details.
Input parameters
ZIP or postal code
City of the contact
Contact's email address
List of website objects for the contact
State or province of the contact
Contact's title or position
List of phone objects for the contact
List of social account objects for the contact
Mailing address of the contact
Company name of the contact
Country of the contact
ID of the list to which the contact will be added
Contact's last name
Contact's first name
List of custom field objects
If true, the API will return an error when a duplicate contact exists
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_DELETE_CONTACTTool to delete a specific contact. Use when you need to remove a contact permanently after confirming it should be deleted. Example: "Delete contact 123".
Input parameters
The unique numeric ID of the contact to delete. Can be obtained from the Get Contacts action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_DELETE_LISTTool to delete a specific contact list. Use when cleaning up unused lists after confirming they are no longer needed. Example: "Delete list 123".
Input parameters
ID of the contact list to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_DELETE_WEBFORMDelete a specific webform from a contact list. Use this to permanently remove a webform that is no longer needed. Requires both the list_id and webform_id - use Get Webforms action first to find these values. Note: The API returns success even for non-existent webform IDs (idempotent delete behavior).
Input parameters
ID of the contact list the webform belongs to. Get this from the Get Lists or Get Webforms action.
ID of the webform to delete. Get this from the Get Webforms action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_GET_CONTACTTool to retrieve a specific contact by ID. Use when you need to fetch full contact details after confirming the contact ID.
Input parameters
ID of the contact to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_GET_CONTACTSRetrieves all contacts from a specific contact list in Campayn. Returns contact details including email, name, address, and confirmation status. Use 'Get Lists' action first to obtain the list_id. Supports optional filtering by contact name/email/company.
Input parameters
The unique ID of the contact list to retrieve contacts from. Use 'Get Lists' action first to obtain valid list IDs.
Optional keyword to filter contacts by name, email, or company. Case-insensitive partial match.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_GET_LISTSTool 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".
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_GET_MESSAGETool to retrieve engagement statistics for a specific email message by ID. Returns views, positive responses (clicks), and negative responses (unsubscribes/bounces). Use GET_MESSAGES first to get the list of available message IDs.
Input parameters
The unique ID of the email message to retrieve statistics for. Use GET_MESSAGES to find available message IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_GET_MESSAGESTool to retrieve all email messages. Use when you need to list all messages visible to the authenticated user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_GET_REPORTSTool 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.
Input parameters
End date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter 'to'.
Start date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter 'from'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_GET_WEBFORMTool 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".
Input parameters
The unique identifier of the contact list that contains the webform. Use CAMPAYN_GET_LISTS to find available list IDs.
The unique identifier of the webform to retrieve. Use CAMPAYN_GET_WEBFORMS to find available webform IDs for a list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_GET_WEBFORMSTool 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".
Input parameters
ID of the list to retrieve webforms from.
Filter forms by type: 0=Signup Page, 1=Embed Signup, 2=WordPress Signup, 3=Facebook Signup.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_UNSUBSCRIBE_CONTACTTool to unsubscribe contacts from a list by contact id or email address. Use when you need to remove contacts from a mailing list. If id is provided, only that specific contact will be unsubscribed. If email is provided, all contacts on that list with that email will be unsubscribed.
Input parameters
The contact ID to unsubscribe. Use this to unsubscribe a specific single contact. Provide either id or email, not both.
The email address to unsubscribe. Use this to unsubscribe all contacts on the list with this email. Provide either id or email, not both.
The ID of the list from which to unsubscribe contacts
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CAMPAYN_UPDATE_LISTTool to update a contact list. Use after confirming list ID and desired changes. Example: Update list 123 name to 'Newsletter Subscribers'.
Input parameters
Comma-separated tags to assign to the list. Omit if not changing tags.
ID of the contact list to update.
New name for the contact list. Omit if not changing the name.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 14 Campayn actions on Nagent, including "Create Contact", "Get Contact" and "Get Contacts". Create Contact: Create a new contact in a specific list. Each action is listed on this page with its input parameters and its output.
Campayn connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Contact takes 2 required inputs: email and list_id. It also takes 14 optional inputs: zip, city, sites, state, title, phones, social, address, company, country, last_name, first_name, custom_fields and failOnDuplicate. It returns data, error and successful.