Skip to main content
Spoki logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 57
  • Triggers: 0
  • Slug: SPOKI
  • Version: 20261101_00

Tools

Slug: SPOKI_ADD_CONTACT_OPERATORTool to assign an operator to a contact’s chat. Use this when you need to assign a team member to handle a specific contact’s conversation. The operator must have been invited to the account first. Rate limited to 5 requests per minute.

Input Parameters

string
required
The contact ID to assign the operator to. This is the unique identifier of the contact in Spoki
string
required
Operator’s email address. The operator must be invited to join the account first before being assigned to a contact. If the operator is not found, the API will return a 400 error

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: SPOKI_ADD_SERVICE_USERAdds a new service user with a specific role to your Spoki account. Use this when you need to create service accounts for automation, API integrations, or specialized operator roles. Rate limit: 10 requests per minute.

Input Parameters

string
required
Name of the service user to be created. This is a human-readable identifier for the service user
string
required
Role to assign to the service user. Common roles include ‘Chat Operator’, ‘Admin’, ‘Agent’, etc. The role must exist in your Spoki account

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: SPOKI_CHECK_ROLE_PRIVATE_KEYTool to check if a service user role has a private key configured. Use when you need to verify key status for a role. Rate limit: 10 requests per minute.

Input Parameters

integer
required
The unique identifier of the role to check for private key

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: SPOKI_CLONE_TEMPLATETool to create a duplicate copy of an existing template. Clone starts in DRAFT status. Use when you need to duplicate a template by ID.

Input Parameters

integer
required
The template ID to clone

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: SPOKI_CREATE_CUSTOM_FIELDCreates a new custom field in Spoki for storing additional contact data. Use this action when you need to define extra data points that can be stored on contacts beyond the standard fields. Custom fields are useful for tracking business-specific information like customer IDs, preferences, subscription dates, or any other structured data. The custom field will be available for use immediately after creation across contact management, automation workflows, and API operations. Ensure the label and code are unique and descriptive for easy identification and usage.

Input Parameters

string
required
Programmatic identifier for the custom field. Must be uppercase with underscores, unique across all custom fields, and not use reserved keywords. Use this code when referencing the field in API calls.
string
required
Human-readable label for the custom field. Must be uppercase, unique across all custom fields, and not use reserved keywords. This label will be visible in the Spoki UI.
string
required
Example or default value for the custom field. Should match the field_type: plain text for TEXT, date format ‘YYYY-MM-DD’ for DATE, datetime format ‘YYYY-MM-DD HH:MM:SS’ for DATETIME.
integer ("1" | "2" | "3")
required
Data type for the custom field. 1 = TEXT (string values), 2 = DATE (date-only values like ‘2024-01-15’), 3 = DATETIME (date and time values like ‘2024-01-15 10:30:00’).

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: SPOKI_CREATE_LISTCreates a new contact list in Spoki for organizing and managing contacts. Use this action when you need to create a new list for grouping contacts by campaigns, segments, or any other organizational criteria. Lists are essential for targeted messaging, automation workflows, and campaign management. Rate limit: 10 requests per minute.

Input Parameters

string
required
Name of the contact list to create. This should be a descriptive name that helps identify the purpose or contents of the list (e.g., ‘Newsletter Subscribers’, ‘VIP Customers’, ‘Marketing Campaign Q1 2024’).

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: SPOKI_CREATE_MEDIATool to create a new media file entry in Spoki. Use when you need to register external media files (images, videos, documents) that can be used in campaigns, messages, or other Spoki features. Rate limit: 120 requests per minute.

Input Parameters

string
required
Title or name of the media file. This will be used to identify the media in the Spoki interface
string
required
Format type of the media file. Common values include ‘image’, ‘video’, ‘audio’, or ‘document’
string
required
MIME type of the media file. Must match the actual file type (e.g., ‘image/jpeg’, ‘image/png’, ‘video/mp4’, ‘application/pdf’)
string
required
External URL where the media file is hosted. Must be a valid, publicly accessible URL (e.g., ‘https://example.com/image.jpg’)

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: SPOKI_CREATE_OR_UPDATE_CONTACTCreates a new contact or updates an existing contact in Spoki using the phone number as the unique identifier. This action performs an “upsert” operation: - If a contact with the provided phone number exists, it will be updated with the new information - If no contact exists with that phone number, a new contact will be created Use this when you need to: - Add new contacts to your Spoki account - Update existing contact information (name, email, language, custom fields) - Ensure contact records are synchronized with external systems The phone number must be in E.164 format (international format with country code).

Input Parameters

string
Email address of the contact. Must be a valid email format
string
required
Contact phone number in E.164 international format (must include country code with + prefix). Examples: ‘+393331234567’ (Italy), ‘+14155552671’ (USA), ‘+447700900123’ (UK)
string
ISO 639-1 two-letter language code for the contact’s preferred language. Common values: ‘en’ (English), ‘it’ (Italian), ‘es’ (Spanish), ‘de’ (German), ‘pt’ (Portuguese), ‘fr’ (French). Defaults to ‘en’ if not specified
string
Last name of the contact. Supports Unicode characters and special characters like hyphens and apostrophes (e.g., ‘O’Brien-Müller’)
string
First name of the contact. Supports Unicode characters for international names (e.g., ‘François’, ‘María’, ‘João’)
object
Dictionary of custom field names and their values. Use this to store additional contact information beyond standard fields (e.g., {‘company’: ‘Acme Corp’, ‘employee_id’: ‘EMP-12345’})

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: SPOKI_CREATE_TEMPLATECreates a WhatsApp message template with localizations and optional buttons and text headers for marketing or transactional messages. Templates are created in DRAFT status and must be approved by WhatsApp before use; rate limit: 10 requests per minute.

Input Parameters

string
required
Internal template name/identifier. Must be unique, lowercase with underscores (e.g., ‘promo_summer_2024’). This is not shown to end users
string ("MARKETING" | "ACCOUNT_UPDATE" | "PAYMENT_UPDATE" | "PERSONAL_FINANCE_UPDATE" | "SHIPPING_UPDATE" | "RESERVATION_UPDATE" | "ISSUE_RESOLUTION" | "APPOINTMENT_UPDATE" | "TRANSPORTATION_UPDATE" | "TICKET_UPDATE" | "ALERT_UPDATE" | "AUTO_REPLY")
required
Template category: MARKETING for promotional content, or specific utility categories like ACCOUNT_UPDATE, PAYMENT_UPDATE, SHIPPING_UPDATE, APPOINTMENT_UPDATE, etc. for transactional messages
string
Optional template subcategory for additional classification
array
required
Array of localizations - at least one required. Each localization defines the template content for a specific language

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: SPOKI_CREATE_TICKETTool to create a new support ticket in Spoki. Use when you need to create a ticket for tracking customer support issues or requests. Rate limit: 120 requests per minute.

Input Parameters

string
required
Title of the ticket. Should be a concise summary of the support issue or request
string
required
Current status of the ticket. Common values: ‘Open’, ‘Closed’, ‘In Progress’, ‘Pending’
string ("Highest" | "High" | "Medium" | "Low" | "Lowest")
required
Priority level of the ticket. Accepted values: Highest, High, Medium, Low, Lowest
string
External reference or ticket ID from another system for tracking purposes
string
Detailed description of the ticket. Provide additional context and information about the support issue or request
string
required
Contact phone number in E.164 international format (must include country code with + prefix). Examples: ‘+1234567890’, ‘+393331234567’

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: SPOKI_DELETE_CONTACTTool to delete a specific contact. Use after confirming the contact ID. Example prompt: “Delete contact with ID 1091234.”

Input Parameters

integer
required
ID of the contact to delete

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: SPOKI_DELETE_CUSTOM_FIELDTool to delete a specific custom field. Cannot delete if the custom field is used in automations. Rate limit: 5 requests per minute.

Input Parameters

integer
required
ID of the custom field to delete

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: SPOKI_DELETE_LISTTool to delete a specific list. Use after confirming the list ID. Rate limit: 5 requests per minute.

Input Parameters

integer
required
ID of the list to delete

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: SPOKI_DELETE_MEDIATool to delete a specific media file. Use after confirming the media ID. Rate limit: 60 requests per minute.

Input Parameters

string
required
ID of the media file to delete

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: SPOKI_DELETE_ROLETool to delete a specific role. Use after confirming the role ID. Cannot delete the sole admin role. Rate limit: 5 requests per minute.

Input Parameters

string
required
ID of the role to delete. Cannot delete the sole admin role.

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: SPOKI_DELETE_TEMPLATETool to delete a WhatsApp template. Use force_delete=true for templates used in automations. Rate limit: 10/min.

Input Parameters

integer
required
ID of the template to delete
boolean
Set to true to force delete templates that are used in automations. Default is 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
Slug: SPOKI_DELETE_TICKETTool to delete a specific ticket. Use after confirming the ticket ID. Rate limit: 60 requests per minute.

Input Parameters

integer
required
ID of the ticket to delete

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: SPOKI_GENERATE_ROLE_PRIVATE_KEYTool to generate a private key for a service user role. Use when you need to create API credentials for service users. Rate limit: 10 requests per minute.

Input Parameters

string
required
The role ID for which to generate a private key

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: SPOKI_GET_ACCOUNT_CURRENT_REPORTTool to get the current report for a specified account. Use when you need up-to-date metrics on messages and conversations for an account. Note: result is cached for 30 minutes.

Input Parameters

integer
required
ID of the account to retrieve the current report for

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: SPOKI_LIST_ACCOUNTSRetrieve a page of Spoki WhatsApp Business accounts and their details, including credit balances, status, and language settings. The endpoint has a rate limit of 5 requests per minute.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Number of results per page, must be >= 1.

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: SPOKI_LIST_AGENCIESTool to list all agencies accessible to the user. Use when you need to retrieve all agencies for the authenticated account.

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: SPOKI_LIST_AUTOMATIONSTool to list, search, and filter automations. Use after authenticating to retrieve available automations and apply optional search or platform filters.

Input Parameters

Search automations by name or webhook link
boolean
Filter by active (true) or inactive (false) automations
string ("Api" | "Active Campaign" | "Woocommerce" | "Magento" | "Prestashop" | "Shopify" | "Zapier" | "Qapla'" | "BrainLead" | "HubSpot" | "Klaviyo" | "Zoho" | "Sendinblue" | "WPNotif" | "Connectif" | "IFTTT" | "Pipedrive" | "Meta" | "Zendesk")
Filter automations by webhook integration platform

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: SPOKI_LIST_CAMPAIGNSList campaigns with optional scheduled-datetime filters and pagination.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Number of results per page, must be >= 1.
string
Only include campaigns scheduled on or after this timestamp (ISO 8601).
string
Only include campaigns scheduled on or before this timestamp (ISO 8601).

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: SPOKI_LIST_CONTACTSTool to list, search, and filter contacts. Use when you need to retrieve contacts with optional search and filters.

Input Parameters

integer
Filter by tag ID
integer
Page number for pagination, must be >= 1.
string
Filter by email (exact match)
string
Filter by phone (exact match)
string
Search query for phone, email, first_name, last_name, language, or notes
string
Filter by language code
integer
Number of results per page, must be >= 1.
string
Filter by last name
string
Filter by first name
boolean
Filter blocked contacts only when true

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: SPOKI_LIST_CUSTOM_FIELDSTool to list, search, and filter custom fields. Use when you need to fetch available custom-field definitions by label or code.

Input Parameters

string
Filter custom fields whose code contains this string
string
Filter custom fields whose label contains this string

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: SPOKI_LIST_LISTSTool to list, search, and filter contact lists. Use when you need to retrieve all lists or find specific lists by name. Rate limit: 5 requests per minute.

Input Parameters

integer
Page number for pagination, must be >= 1.
string
Search query to filter lists by name
integer
Number of results per page, must be >= 1.

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: SPOKI_LIST_MEDIALists a page of media files in the account, including details such as title, content type, format, and URLs. Supports pagination.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Number of results per page, must be >= 1.

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: SPOKI_LIST_PARTNERSList all partners accessible to the authenticated account. Partners represent business partners or affiliates associated with your Spoki account.

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: SPOKI_LIST_REPORTSTool to list, search, and filter usage reports. Use when you need to retrieve historical usage metrics with optional filters. Note: results are cached for 30 minutes.

Input Parameters

integer
Page number for pagination, must be >= 1.
integer
Filter reports by account ID
integer
Number of results per page, must be >= 1.
string
Filter by reporting period granularity (e.g., ‘Month’, ‘Day’)
string
Filter reports by period start date (YYYY-MM-DD format)

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: SPOKI_LIST_ROLESLists a page of user role assignments in the account, including pagination links when available.

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: SPOKI_LIST_TAGSLists a page of tags in the account, including each tag’s ID, name, color, and order. The response includes a next-page URL when available.

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: SPOKI_LIST_TEMPLATESTool to list, search, and filter WhatsApp templates. Use when you need to retrieve available templates, optionally filtering by keywords.

Input Parameters

string
Search term to filter templates by id, name, or text

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: SPOKI_LIST_TICKETSLists tickets with optional pagination and sorting.

Input Parameters

integer
Page number for pagination, must be >= 1.
string ("asc" | "desc")
Order of sorting: ‘asc’ or ‘desc’.
string
Field to sort by, e.g., created_datetime.
integer
Number of tickets per page, must be >= 1.

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: SPOKI_REMOVE_ALL_LIST_CONTACTSTool to remove all contacts from a list. Use when you need to clear all contacts from a specific list. Rate limit: 5 requests per minute.

Input Parameters

integer
required
The list ID from which to remove all contacts

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: SPOKI_REMOVE_CONTACT_OPERATORTool to remove an operator from a contact’s chat. Use when you need to unassign an operator from handling a specific contact’s conversations. Rate limit: 5 requests per minute.

Input Parameters

string
required
The contact ID from which to remove the operator
string
required
Operator’s email address to be removed from the contact’s chat. This must be the email of a service user or operator in your Spoki account

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: SPOKI_REMOVE_LIST_CONTACTSTool to remove specific contacts from a list. Use when you need to unsubscribe or remove multiple contacts from a particular list. Rate limit: 5 requests per minute.

Input Parameters

integer
required
The ID of the list from which contacts should be removed
array
required
Array of contact IDs to remove from the list. Each ID must be a valid contact identifier

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: SPOKI_RESEND_INVITATIONTool to resend an invitation email. Use when you need to resend an existing invitation. Rate limit: 5 requests per minute.

Input Parameters

integer
required
The invitation ID to resend

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: SPOKI_RETRIEVE_ACCOUNTRetrieves detailed information about a specific Spoki WhatsApp Business account. Returns comprehensive account details including credit balance, verification status, messaging limits, quality metrics, timezone settings, and Facebook integration configuration. Use this action when you need to check account status, credit levels, or configuration details. Note: You must have access permissions for the specified account ID.

Input Parameters

integer
required
The unique identifier of the Spoki account to retrieve. Must be a valid account ID accessible to the authenticated user.

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: SPOKI_RETRIEVE_AUTOMATIONTool to retrieve details of a specific automation. Use when you need name, first message, webhooks and timestamps of an existing automation.

Input Parameters

integer
required
ID of the automation to retrieve

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: SPOKI_RETRIEVE_CONTACTTool to retrieve details of a specific contact. Use when you have a contact ID and need full profile details.

Input Parameters

integer
required
Unique identifier of the contact to retrieve

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: SPOKI_RETRIEVE_CUSTOM_FIELDTool to retrieve details of a specific custom field. Use when you have a field ID and need its metadata before using it in automations.

Input Parameters

integer
required
The unique identifier of the custom field to retrieve

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: SPOKI_RETRIEVE_LISTTool to retrieve details of a specific list by ID. Use when you need list metadata and contact count. Rate limit: 5 requests per minute.

Input Parameters

integer
required
Unique identifier of the list to retrieve

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: SPOKI_RETRIEVE_MEDIATool to retrieve details of a specific media file by ID. Use when you need media file metadata.

Input Parameters

string
required
Unique identifier of the media file to retrieve

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: SPOKI_RETRIEVE_ROLETool to retrieve details of a specific role by ID. Use when you need role information for a given role ID. Rate limit: 5 requests per minute.

Input Parameters

string
required
ID of the role to retrieve

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: SPOKI_RETRIEVE_TAGTool to retrieve details of a specific tag. Use when you need tag metadata by ID.

Input Parameters

integer
required
ID of the tag to retrieve

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: SPOKI_RETRIEVE_TEMPLATETool to retrieve details of a specific template. Use after obtaining a template ID.

Input Parameters

integer
required
Unique identifier of the template to retrieve

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: SPOKI_REVERT_TEMPLATE_TO_DRAFTTool to revert a WhatsApp template back to DRAFT status, removing it from WhatsApp. Use when you need to unpublish a template and return it to draft mode for editing.

Input Parameters

integer
required
Unique identifier of the template to revert to DRAFT status

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: SPOKI_SYNC_CONTACTS_BULKTool to bulk sync (create or update) multiple contacts in a single request. Rate limit: 1 request per minute. This action performs bulk “upsert” operations: - If a contact with the provided phone number exists, it will be updated with the new information - If no contact exists with that phone number, a new contact will be created Use when you need to: - Import multiple contacts from external systems - Synchronize contact lists in bulk - Efficiently create or update many contacts at once IMPORTANT: Do not use this action to update contacts before initiating an automation. The strict rate limit (1/min) makes it unsuitable for automation workflows.

Input Parameters

array
required
List of contact objects to sync. Each contact will be created if new or updated if the phone number already exists. Maximum recommended: 100 contacts per request due to rate limits

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: SPOKI_SYNC_LIST_CONTACTSTool to create or update contacts and add them to a specific list in Spoki. Rate limit: 1 request per minute. This action performs bulk “upsert” operations and list assignment: - If a contact with the provided phone number exists, it will be updated with the new information - If no contact exists with that phone number, a new contact will be created - All synced contacts are automatically added to the specified list Use when you need to: - Add multiple contacts to a specific list - Import contacts from external systems directly into a list - Synchronize contact lists with list membership Maximum 500 contacts per request. Phone numbers must be in E.164 format (international format with country code).

Input Parameters

string
required
The unique identifier of the list to sync contacts to. Contacts will be created or updated and then added to this list
array
required
List of contact objects to sync to the list. Each contact will be created if new or updated if the phone number already exists, then added to the specified list. Maximum: 500 contacts per request

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: SPOKI_UPDATE_CAMPAIGNTool to update an existing campaign’s name, status, or scheduled time. Use when you need to modify campaign details after creation. Rate limited to 5 requests per minute.

Input Parameters

string
required
The unique identifier of the campaign to update
string
New name for the campaign
string ("Draft" | "Scheduled")
Allowed campaign status values.
string
Scheduled start time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ). Required when status is ‘Scheduled’

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: SPOKI_UPDATE_CONTACTTool to update an existing contact in Spoki. Use when you need to modify contact information for a specific contact ID. Only the fields provided will be updated; other fields remain unchanged.

Input Parameters

string
required
Unique identifier of the contact to update. This is the contact ID returned when creating or listing contacts
string
Email address of the contact. Must be a valid email format
string
Contact phone number in E.164 international format (must include country code with + prefix). Examples: ‘+393331234567’ (Italy), ‘+14155552671’ (USA), ‘+447700900123’ (UK)
string
ISO 639-1 two-letter language code for the contact’s preferred language. Common values: ‘en’ (English), ‘it’ (Italian), ‘es’ (Spanish), ‘de’ (German), ‘pt’ (Portuguese), ‘fr’ (French)
string
Last name of the contact. Supports Unicode characters and special characters like hyphens and apostrophes (e.g., ‘O’Brien-Müller’)
string
First name of the contact. Supports Unicode characters for international names (e.g., ‘François’, ‘María’, ‘João’)
object
Dictionary of custom field names and their values. Use this to store additional contact information beyond standard fields (e.g., {‘company’: ‘Acme Corp’, ‘employee_id’: ‘EMP-12345’})

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: SPOKI_UPDATE_CUSTOM_FIELDTool to update a specific custom field. Use after retrieving a field to change its label.

Input Parameters

string
required
New display label of the custom field
integer
required
Unique identifier of the custom field to update

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: SPOKI_UPDATE_INVITATION_ROLETool to update the role of a pending invitation. Use when you need to change the role assigned to an existing invitation. Rate limit: 5 requests per minute.

Input Parameters

string
required
The invitation ID to update the role for
string
required
New role to assign to the invitation. Common roles include ‘Administrator’, ‘Chat Operator’, ‘Admin’, ‘Agent’, etc.

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: SPOKI_UPDATE_MEDIATool to update an existing media file in Spoki. Use when you need to modify media file details like title. Rate limit: 120 requests per minute.

Input Parameters

integer
required
Unique identifier of the media file to update
string
required
New title for the media file

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: SPOKI_UPDATE_ROLETool to update a user’s role. Use when you need to change a user’s role assignment. Rate limit: 10 requests per minute.

Input Parameters

string
required
The role ID to update
string
required
New role name to assign to the user

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: SPOKI_UPDATE_TEMPLATETool to update an existing WhatsApp template in Spoki. Use when you need to modify template name, category, subcategory, or localization details. Rate limit: 10 requests per minute.

Input Parameters

integer
required
Unique identifier of the template to update
string
New name for the template
string
Template category (e.g., ‘ACCOUNT_UPDATE’, ‘MARKETING’, ‘UTILITY’)
string
Template subcategory for further classification
array
Array of localizations to update for this template

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