Spoki

Learn how to use Spoki with Composio

Overview

Enum

SPOKI

Description

Spoki is an Italian platform that integrates WhatsApp’s official APIs to automate communication for marketing, sales, customer support, and payments.

Authentication Details

api_key
stringRequired
api_key
stringRequired
username
stringRequired

Actions

Tool to create a new custom field. use when defining extra data points for contacts.

Action Parameters

code
stringRequired
example
stringRequired
field_type
integerRequired
label
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to create or update a contact. use when you need to upsert a single contact record via the sync endpoint.

Action Parameters

custom_fields
object
email
string
first_name
string
language
string
last_name
string
phone
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a specific contact. use after confirming the contact id. example prompt: "delete contact with id 1091234."

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool 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.

Action Parameters

account_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to list all agencies accessible to the user. use when you need to retrieve all agencies for the authenticated account.

Action Parameters

Action Response

data
array
error
string
successful
boolean
Tool to list, search, and filter automations. use after authenticating to retrieve available automations and apply optional search or platform filters.

Action Parameters

is_active
boolean
search
string
webhook_platform
string

Action Response

data
object
error
string
successful
boolean
Tool to list, search, and filter campaigns. use when you need to retrieve campaigns optionally filtered by scheduled datetime.

Action Parameters

scheduled_datetime_gte
string
scheduled_datetime_lte
string

Action Response

data
object
error
string
successful
boolean
Tool to list, search, and filter contacts. use when you need to retrieve contacts with optional search and filters.

Action Parameters

email
string
first_name
string
is_blocked
boolean
language
string
last_name
string
phone
string
search
string
tag
integer

Action Response

data
object
error
string
successful
boolean
Tool to list, search, and filter tags. use when you need to fetch all tags for the account.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to list, search, and filter whatsapp templates. use when you need to retrieve available templates, optionally filtering by keywords.

Action Parameters

search
string

Action Response

data
object
error
string
successful
boolean
Tool to list, search, and filter tickets. use when you need to retrieve tickets with optional pagination and filters.

Action Parameters

order
string
page
integer
per_page
integer
sort_by
string
status
string

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific account. use after confirming the account id is valid.

Action Parameters

account_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific automation. use after listing automations to fetch full details including webhooks and timestamps. example: retrieve automation with id 345016.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific contact. use when you have a contact id and need full profile details.

Action Parameters

contact_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific tag. use when you need tag metadata by id.

Action Parameters

id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific template. use after obtaining a template id.

Action Parameters

template_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to list, search, and filter custom fields. use when you need to fetch available custom-field definitions by label or code.

Action Parameters

code
string
label
string

Action Response

data
object
error
string
successful
boolean
Tool to list, search, and filter tags. use when you need to fetch all tags for the account.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to list, search, and filter whatsapp templates. use when you need to retrieve available templates, optionally filtering by keywords.

Action Parameters

search
string

Action Response

data
object
error
string
successful
boolean
Tool to retrieve details of a specific custom field. use when you have a field id and need its metadata before using it in automations.

Action Parameters

custom_field_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to update a specific custom field. use after retrieving a field to change its label.

Action Parameters

custom_field_id
integerRequired
label
stringRequired

Action Response

data
object
error
string
successful
boolean
Deprecated placeholder for spoki list partners action file

Action Parameters

Action Response

data
object
error
string
successful
boolean