Skip to main content
Viral Loops logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: VIRAL_LOOPS
  • Version: 20261030_00

Tools

Slug: VIRAL_LOOPS_GET_CAMPAIGN_INFOReturn the connected campaign’s identity, template, expiration mode and date, points, GDPR, and integration configuration without bulky presentation styling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIRAL_LOOPS_GET_CAMPAIGN_STATSReturn the connected campaign’s lead count and total referral count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIRAL_LOOPS_GET_PARTICIPANTReturn one participant’s profile, referral totals, rank, referrer, and reward summaries by email or referral code.

Input Parameters

string
Participant email selector. Provide exactly one of email or referral_code.
string
Participant referral-code selector. Provide exactly one of referral_code or email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIRAL_LOOPS_LIST_PARTICIPANT_REFERRALSReturn one participant’s referrals by email or referral code, with explicit offset pagination. The provider’s response fields and pagination metadata are preserved as returned.

Input Parameters

string
Participant email selector. Provide exactly one of email or referral_code.
integer
Maximum referrals requested for this page. The provider’s maximum is unverified.
integer
Zero-based number of referrals to skip.
string
Participant referral-code selector. Provide exactly one of referral_code or email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIRAL_LOOPS_LOOK_UP_PARTICIPANTSBatch lookup exact participant and referrer identifiers, returning matching campaign records with explicit offset pagination.

Input Parameters

integer
Maximum matching records requested. The provider’s maximum is unverified.
integer
Zero-based number of matching records to skip.
array
Referrer identifiers to look up. Each item must contain exactly one email or referral_code.
array
Participant identifiers to look up. Each item must contain exactly one email or referral_code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIRAL_LOOPS_REGISTER_PARTICIPANTRegister an email address in the connected campaign, optionally with a referrer and participant metadata. This creates persistent participant data; Viral Loops provides no API operation to delete it.

Input Parameters

string
required
Valid email address of the participant to register.
object
Campaign consent names and values to store for this participant.
string
Participant’s last name.
object
Campaign-specific custom participant fields to store.
string
Participant’s first name.
string
Acquisition channel or origin to record for this participant.
string
Referral source value to record for this participant.
string
Referral code of the participant who referred this registration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIRAL_LOOPS_SEARCH_PARTICIPANTSSearch campaign participants by text, conversion status, and acquisition source, with explicit offset pagination.

Input Parameters

integer
Maximum participants requested for this page; the provider’s maximum is unverified.
integer
Zero-based number of participants to skip.
string ("all" | "referred" | "organic")
How included participants were acquired.
string
Text to match against searchable participant fields.
string ("all" | "pending" | "converted")
Conversion state to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIRAL_LOOPS_TRACK_PARTICIPANT_CONVERSIONIRREVERSIBLE: Record a conversion event for one registered participant. This operation cannot be undone and may affect conversion counts, campaign automation, and rewards. It is available only for Milestone Referral, Altruistic Referral, Online to Offline, and Universal Referral campaign templates; other templates reject it. Identify the participant by exactly one email or referral code, and optionally attach a numeric conversion value.

Input Parameters

string
Participant email selector; provide exactly one of email or referral_code.
number
Numeric value associated with this irreversible conversion event.
string
Participant referral-code selector; provide exactly one of referral_code or email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: VIRAL_LOOPS_UPDATE_PARTICIPANTUpdate one participant’s name, referral or conversion counts, or custom data, identified by email or referral code. Campaign emails and connected integration triggers default to off; when enabled, those side effects cannot be undone.

Input Parameters

string
Participant email selector; provide exactly one of email or referral_code.
string
New last name; explicitly pass null to clear the stored value.
object
Campaign-specific custom participant fields to merge into existing data. Omitted existing keys are retained.
string
New first name; explicitly pass null to clear the stored value.
boolean
Whether this update may send campaign emails. Defaults to false.
string
Participant referral-code selector; provide exactly one of referral_code or email.
integer
New non-negative referral count to store for the participant.
integer
New non-negative conversion count to store for the participant.
boolean
Whether this update may trigger connected integrations. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not