NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Dripcel connects to a Nagent workspace with an API key. Once it is connected, agents can call 18 Dripcel actions, such as "Create Contacts in Bulk", "Get current credit balance" and "Get Dripcel Campaigns". 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 Dripcel, with input parameters and output schema.
DRIPCEL_CREATE_CONTACTSTool to upload a list of new contacts to Dripcel in bulk. Only creates new contacts (does not update existing ones). Use when you need to add multiple contacts to your Dripcel account at once. Maximum 100,000 contacts per request.
Input parameters
Optional send object to trigger a message send upon contact upload.
Country code for parsing cell numbers. Use 'ZA' for South Africa or 'NA' for Namibia.
Array of tag IDs to apply to all uploaded contacts. Use GET /tags to retrieve valid tag IDs.
Array of contact objects to upload. Maximum 100,000 contacts per request.
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
DRIPCEL_DELETE_CONTACTTool to delete a contact by their cell number. Use when you need to remove a contact from Dripcel after confirming the MSISDN.
Input parameters
The MSISDN (E.164 formatted) of the contact 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
DRIPCEL_DELETE_TAGTool to delete a tag by its ID. Use when you need to remove a tag from Dripcel. Warning: This will also remove the tag from all contacts and campaigns that have it.
Input parameters
The ID of the tag to delete. This will also remove the tag from all contacts and campaigns that have it.
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
DRIPCEL_GET_BALANCERetrieves the current credit balance for your Dripcel organization account. This action requires no input parameters and returns the available credit balance as a numeric value. Use this to check your account balance before performing credit-consuming operations like sending SMS messages. The balance is returned in your account's default currency (not explicitly specified in the response).
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
DRIPCEL_GET_CAMPAIGNSRetrieves a list of campaigns from Dripcel. Supports optional pagination (page, pageSize) and filtering by campaign status. Returns campaign details including ID, name, status, and timestamps.
Input parameters
Page number for pagination, must be >=1
Filter campaigns by status (e.g., 'active', 'paused', 'completed')
Number of items per page, must be >=1
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
DRIPCEL_GET_CONTACTTool to retrieve a single contact by their cell number (MSISDN). Use when you need to view details of a specific contact including their name, email, tags, and other metadata.
Input parameters
The MSISDN (phone number) of the contact to retrieve. Can be in E.164 format (+15555551234) or without the plus sign (15555551234).
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
DRIPCEL_GET_DELIVERIESTool to retrieve SMS/email delivery records from Dripcel. Returns a list of message deliveries filtered by recipient phone number (cell) or send operation ID (customerId). Useful for tracking message delivery status, checking delivery history for a specific contact, or auditing a particular send operation.
Input parameters
The MSISDN of the contact to query deliveries for
The unique ID of a particular send to query deliveries for (24-character hex string, MongoDB ObjectId format)
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
DRIPCEL_GET_EMAIL_TEMPLATESRetrieves all email templates from your Dripcel account. Returns a list of templates with their IDs, names, subjects, and content. Use this action when you need to: - View all available email templates in your account - Get template IDs for use in email sending operations - Check template content before selecting one for a campaign - List templates to verify template creation or updates Note: According to API documentation, this endpoint returns all templates without documented support for pagination or filtering.
Input parameters
Page number for pagination (undocumented parameter, support not guaranteed).
Field name to sort results by, such as 'created_at' or 'name' (undocumented parameter, support not guaranteed).
Maximum number of templates to return per page (undocumented parameter, support not guaranteed).
Sort order: 'asc' for ascending or 'desc' for descending (undocumented parameter, support not guaranteed).
Search term to filter templates by name or content (undocumented parameter, support not guaranteed).
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
DRIPCEL_GET_SALESTool to retrieve a list of all sales. Use when you need comprehensive sales data for reporting or analytics.
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
DRIPCEL_LIST_TAGSTool to retrieve all tags in your Dripcel organization. Use when you need to view available tags, get tag IDs for adding to contacts, or verify tag existence before operations.
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
DRIPCEL_OPT_OUT_CONTACTTool to opt out a contact from multiple campaigns at once. Use when you need to remove a contact from campaign messaging. More robust than single campaign opt-out, allowing batch operations or opting out from all campaigns at once.
Input parameters
If true, opt out the contact from all existing and future campaigns. Takes precedence over campaign_ids.
The MSISDN (E.164 formatted phone number) of the contact to opt out.
List of campaign IDs to opt out from. If not provided and 'all' is false, no campaigns will be opted out.
If true, create the contact if it doesn't exist before opting out.
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
DRIPCEL_POST_COMPLIANCE_SENDCheck if phone numbers are allowed to receive SMS messages based on opt-out status and campaign targeting rules. Returns whether each number can be sent to, helping ensure compliance before sending messages. Costs 0.14 credits per phone number checked.
Input parameters
List of phone numbers to verify compliance for. For South Africa (ZA), numbers must start with '0' or '27' followed by up to 9 digits.
ISO 3166-1 alpha-2 country code of the phone numbers (e.g., 'ZA' for South Africa).
Campaign ID (24-character hex ObjectId) to check phone numbers against campaign-specific targeting criteria. If omitted, only global opt-outs will be checked.
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
DRIPCEL_POST_REPLIES_SEARCHSearch for SMS/message replies with flexible filtering by ID, campaign, phone number, reply type, message content, or date range. Returns matching replies with metadata. All filters are optional and can be combined for precise queries.
Input parameters
Reply ID(s) to filter. Must be 24-character hex ObjectID(s). Use single ID or list for OR matching.
Reply type(s): optIn, optOut, or unknown.
Sender phone number(s) in full international format (e.g., +1234567890).
Content of the reply message.
Date-range filter for when the reply was received.
Campaign ID(s) that triggered the reply. Must be 24-character hex ObjectID(s).
ID(s) of the send(s) being replied to. Must be 24-character hex ObjectID(s).
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
DRIPCEL_PUT_CONTACT_TAG_ADDAdd one or more tags to a contact identified by phone number. Use this tool to organize contacts by assigning tags for segmentation and targeting. Tags must exist in the system before being added - use GET /tags to retrieve valid tag IDs. Provide either tag_ids (recommended) or tag names. Set create_missing_contact=true to automatically create the contact if they don't exist in your Dripcel account. Response includes matchedCount (contacts found) and modifiedCount (contacts updated).
Input parameters
Phone number of the contact in E.164 international format (e.g., +15551234567). Must include country code with + prefix.
List of tag names to add to the contact. Tag names are less stable than IDs as they can be renamed. Must provide either tag_ids or tags.
List of tag IDs to add to the contact. Use GET /tags to retrieve valid tag IDs. Must provide either tag_ids or tags (tag_ids preferred).
If true, automatically creates the contact if it doesn't exist. If false, operation only succeeds if contact exists (matchedCount will be 0 if contact not found).
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
DRIPCEL_SEARCH_SEND_LOGSSearch for SMS send logs with flexible filtering by ID, phone number, campaign, delivery, message content (regex), or date range. Supports MongoDB-style queries with projection and pagination. All filters are optional and can be combined.
Input parameters
MongoDB-style query filter for send logs.
Pagination options for result set.
Fields to return in results. Use {field: 1} syntax.
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
DRIPCEL_SEND_BULK_EMAILTool to send bulk emails to multiple recipients using a template. Use when you need to send the same email content to many contacts at once.
Input parameters
The email address to send from.
The _id of the email template to use for the bulk send.
Schedule to send for a future time. Default is to send immediately.
List of recipient email addresses to send to.
Filter out email addresses that aren't in your Dripcel contacts. Required if the template contains custom fields to replace.
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
DRIPCEL_SEND_SMSTool to send a single SMS to a contact. Use when you need to deliver a targeted message immediately or schedule it for later.
Input parameters
Recipient's phone number in international E.164 format.
SMS encoding type. Use 'unicode' if message contains non-GSM characters.
Sender ID or phone number (alphanumeric up to 11 chars or E.164 format).
Country code for SMS delivery.
SMS text content, up to 1600 characters.
Optional scheduled send time in 'YYYY-MM-DD HH:MM' (24-hour) format.
Optional campaign ID to associate the send.
Delivery method to use for the SMS.
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
DRIPCEL_UPSERT_CONTACTSTool to upload contacts in bulk, creating new contacts or updating existing ones. Limit: 20,000 contacts per request. Use when you need to import or sync a list of contacts to Dripcel. Invalid contacts will be reported but won't block the operation.
Input parameters
Configuration for triggering a send to contacts after upload.
Country code for parsing cell numbers. Use when contacts don't have country codes in their numbers.
List of tag IDs to apply to ALL contacts in this upload. Individual contact tag_ids will be merged with these.
Array of contact objects to upload. Limit: 20,000 contacts per request. Each contact requires at minimum a cell number.
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 18 Dripcel actions on Nagent, including "Create Contacts in Bulk", "Get current credit balance" and "Get Dripcel Campaigns". Create Contacts in Bulk: Upload a list of new contacts to Dripcel in bulk. Each action is listed on this page with its input parameters and its output.
Dripcel 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 Contacts in Bulk takes 1 required input: contacts. It also takes 3 optional inputs: send, country and tag_ids. It returns data, error and successful.