Skip to main content
POST
Add Shopify assistant tools

CLI

Autorizaciones

Authorization
string
header
requerido

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Parámetros de ruta

id
string<uuid>
requerido

Linked Shopify store ID

Cuerpo

application/json
assistant_id
string<uuid>
requerido

Assistant receiving store tools

actions
enum<string>[]
requerido

Unique supported action IDs to add

Required array length: 1 - 20 elements
Opciones disponibles:
lookup_order,
search_products,
get_product_inventory,
get_shop_policies,
request_cancellation,
request_refund,
request_address_change,
create_support_ticket,
get_shop_context,
get_product,
get_customer_context,
get_return_eligibility,
start_customer_verification,
prepare_draft_order,
prepare_order_cancellation,
prepare_address_change,
prepare_return,
prepare_draft_invoice,
execute_shopify_proposal,
get_shopify_proposal

Respuesta

Add Shopify assistant tools.

data
object[]
requerido