Add a customer to the blacklist to prevent future transactions
\nBearer Token with permission: api:customers.blacklist.add
Remove a customer from the blacklist to allow future transactions
\nBearer Token with permission: api:customers.blacklist.remove
Check if a customer is blacklisted and view their blacklist details
\nBearer Token with permission: api:customers.blacklist.check
No request body required. The customer is identified by the customer_number in the URL path.
\nCancel all or specific subscriptions for a customer
\nBearer Token with permission: api:customers.subscriptions.cancel
The endpoint accepts either a customer_number or subscription_number as the identifier in the URL path
\nIf a subscription_number is provided in the URL, only that subscription will be canceled
\nIf a customer_number is provided in the URL and no subscription_number in the request body, all cancelable subscriptions will be canceled
\nIf both URL identifier and request body subscription_number are provided, the subscription must belong to the specified customer
\nCancel all or specific fulfillments for a customer
\nBearer Token with permission: api:customers.fulfillments.cancel
The endpoint accepts either a customer_number or fulfillment_number as the identifier in the URL path
\nIf a fulfillment_number is provided in the URL, only that fulfillment will be canceled
\nIf a customer_number is provided in the URL and no fulfillment_number in the request body, all cancelable fulfillments will be canceled
\nIf both URL identifier and request body fulfillment_number are provided, the fulfillment must belong to the specified customer
\nOnly fulfillments with status PENDING, PROCESSING, or ON_HOLD can be canceled
\nOptional. Forces an update of this order instead of creating a new lead, as long as it is not in a complete/terminal status.
\n","type":"text","disabled":true},{"key":"customer[email]","value":"test@example.com","type":"text"},{"key":"customer[first_name]","value":"John","type":"text"},{"key":"customer[last_name]","value":"Doe","type":"text"},{"key":"customer[phone]","value":"5551234567","type":"text"},{"key":"shipping[address1]","value":"123 Main St","type":"text"},{"key":"shipping[address2]","value":"Apt 4B","type":"text"},{"key":"shipping[city]","value":"New York","type":"text"},{"key":"shipping[state]","value":"NY","type":"text"},{"key":"shipping[postal_code]","value":"10001","type":"text"},{"key":"shipping[country]","value":"US","type":"text"},{"key":"campaign_id","value":"1","type":"text"},{"key":"currency","value":"USD","type":"text"},{"key":"utm_source","value":"google","type":"text"},{"key":"utm_medium","value":"cpc","type":"text"},{"key":"utm_campaign","value":"summer_sale","type":"text"},{"key":"utm_term","value":"best deals","type":"text"},{"key":"utm_content","value":"banner1","type":"text"},{"key":"affiliate","value":"AFF123","type":"text"},{"key":"sub1","value":"SUB456","type":"text"},{"key":"custom_fields[partner_ref]","value":"ACME-2024-Q4","type":"text"},{"key":"custom_fields[landing_variant]","value":"hero-v3","type":"text"},{"key":"products[0][offer_id]","value":"1","type":"text"},{"key":"products[0][quantity]","value":"1","type":"text"},{"key":"products[1][offer_id]","value":"2","type":"text"},{"key":"products[1][quantity]","value":"1","type":"text"},{"key":"ip_address","value":"192.168.1.1","type":"text"},{"key":"user_agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36","type":"text"},{"key":"enrich","value":"true","type":"text","disabled":true}]},"url":"https://api.sparkcrm.io/checkout/leads","description":"Create a new lead within Spark CRM.
\n\n\nUpdating an existing order: Pass
\norder_numberto force this request to update that specific order instead of creating a new lead. The order must belong to your team and must not be in a completed, successful, or terminal status (completed, processing, refunded, partially/externally/RDR/alert refunded, disputed, chargeback, voided, or canceled) — otherwise the request is rejected with a422. If no order matches theorder_numberfor your team, the request is also rejected with a422.
Bearer Token from collection Spark CRM
\nOptional. Updates the order's contact email. Empty values are ignored.
\n","key":"customer[email]","value":"updated@example.com","type":"text","disabled":true},{"description":"Optional. Updates the contact first name. Empty values are ignored.
\n","key":"customer[first_name]","value":"Jane","type":"text","disabled":true},{"description":"Optional. Updates the contact last name. Empty values are ignored.
\n","key":"customer[last_name]","value":"Doe","type":"text","disabled":true},{"description":"Optional. Updates the contact phone. Empty values are ignored.
\n","key":"customer[phone]","value":"5559876543","type":"text","disabled":true},{"type":"text","key":"payment[method]","value":"card"},{"type":"text","key":"payment[card_number]","value":"4111111111111111"},{"type":"text","key":"payment[card_exp_month]","value":"12"},{"type":"text","key":"payment[card_exp_year]","value":"2025"},{"type":"text","key":"payment[card_cvv]","value":"123"},{"type":"text","key":"billing[address1]","value":"123 Main St"},{"type":"text","key":"billing[address2]","value":"Apt 4B"},{"type":"text","key":"billing[city]","value":"New York"},{"type":"text","key":"billing[state]","value":"NY"},{"type":"text","key":"billing[postal_code]","value":"10001"},{"type":"text","key":"billing[country]","value":"US"},{"type":"text","key":"coupon_code","value":"","disabled":true},{"type":"text","key":"campaign_id","value":"","disabled":true},{"type":"text","key":"shipping[address1]","value":"456 Oak Ave","disabled":true},{"type":"text","key":"shipping[address2]","value":"Suite 100","disabled":true},{"type":"text","key":"shipping[city]","value":"Los Angeles","disabled":true},{"type":"text","key":"shipping[state]","value":"CA","disabled":true},{"type":"text","key":"shipping[postal_code]","value":"90001","disabled":true},{"type":"text","key":"shipping[country]","value":"US","disabled":true},{"type":"text","key":"shipping[phone]","value":"555-123-4567","disabled":true},{"type":"text","key":"billing[phone]","value":"555-987-6543","disabled":true},{"type":"text","key":"products[0][offer_id]","value":"offer_abc123","disabled":true},{"type":"text","key":"products[0][quantity]","value":"1","disabled":true},{"type":"text","key":"products[0][price]","value":"29.99","disabled":true},{"type":"text","key":"products[0][shipping_price]","value":"4.99","disabled":true},{"type":"text","key":"tax_amount","value":"2.62","disabled":true},{"type":"text","key":"tax_rate","value":"0.0875","disabled":true},{"type":"text","key":"forceQA","value":"false","disabled":true},{"type":"text","key":"gateway_id","value":"1","disabled":true},{"type":"text","key":"payment_orchestrator_id","value":"1","disabled":true},{"type":"text","key":"terms_accepted","value":"true","disabled":true},{"type":"text","key":"privacy_accepted","value":"true","disabled":true},{"type":"text","key":"custom_fields[partner_ref]","value":"ACME-2024-Q4","disabled":true},{"type":"text","key":"custom_fields[stage]","value":"checkout","disabled":true}]},"url":"https://api.sparkcrm.io/checkout/orders/payment","description":"Process a payment for an existing lead that was created from the Create Lead endpoint
\nBearer Token from collection Spark CRM
\nPass any customer[...] fields to update the order's existing contact at payment time — handy for completing a lead created with only an email. Provided fields are written to the contact; empty values are skipped so a blank never overwrites an existing name, email, or phone.
Standard payment processing. The order is created and payment is captured immediately.
\nFor payments processed outside the platform. Set payment.method to \"external\" and optionally pass payment.external_payment_id to link the transaction to a specific alternative payment method configured in the CRM. The order completes immediately with no gateway interaction.
Redirect-based payment flow requiring three steps:
\nProcess Payment — Call this endpoint with payment.method set to \"paypal_wallet\", along with return_url and cancel_url. The response includes a redirect_url.
Customer Approval — Redirect the customer to the redirect_url. They log in to PayPal and approve the payment. PayPal redirects them back to your return_url.
Capture Payment — Call POST /checkout/orders/capture with the order_number to finalize the charge. Money does not move until this step.
Two ways to populate the order's tax:
\ntax_amount (and optionally tax_rate) in the request body. Typical flow: call POST /checkout/tax first to get the calculated values, then pass them here to lock in what the customer saw on the checkout page. The customer is always charged the tax_amount you supply.Charge vs. report are separate decisions:
\ntax_amount controls what the customer pays.tax_enabled flag + active provider. If the campaign has tax disabled, the customer is still charged the supplied tax_amount, but nothing is reported to TaxJar's books.Set to true when the order is being placed as a 3rd-party-managed subscription so it appears in the customer's subscription records and subscription reports.
\n","disabled":true}]},"url":"https://api.sparkcrm.io/checkout/orders","description":"Create a new order within the CRM
\nBearer Token from collection Spark CRM
\nStandard payment processing. The order is created and payment is captured immediately.
\nFor payments processed outside the platform. Set payment.method to \"external\" and optionally pass payment.external_payment_id to link the transaction to a specific alternative payment method configured in the CRM. The order completes immediately with no gateway interaction.
Redirect-based payment flow requiring three steps:
\npayment.method set to \"paypal_wallet\", along with return_url and cancel_url. The response includes a redirect_url.redirect_url. They log in to PayPal and approve the payment. PayPal redirects them back to your return_url.POST /checkout/orders/capture with the order_number to finalize the charge. Money does not move until this step.Two ways to populate the order's tax:
\ntax_amount (and optionally tax_rate) in the request body. Typical flow: call POST /checkout/tax first to get the calculated values, then pass them here to lock in what the customer saw on the checkout page. The customer is always charged the tax_amount you supply.Charge vs. report are separate decisions:
\ntax_amount controls what the customer pays.tax_enabled flag + active provider. If the campaign has tax disabled, the customer is still charged the supplied tax_amount, but nothing is reported to TaxJar's books.Set is_subscription=true when this order is being placed for a customer whose subscription lifecycle is handled by an external subscription manager. Spark records a synthetic externally-managed subscription on the order so it surfaces in the customer's subscription records and subscription reports — but does not schedule billing, fire process-reminder webhooks, or attempt renewals on it. The external system is responsible for billing the customer.
This flag is independent of any subscription-typed offer/upsell on the order. If the order's offer/upsell is configured with sale type 3rd Party Subscription Manager, that path produces its own externally-managed subscription with the configured external_provider, process_reminder_hours_before, and billing_interval_days — is_subscription is only needed for one-off external-subscription orders that don't use a configured offer.
card or onfile. Omit the whole payment object to charge the card on file.
\n","disabled":true},{"value":"4111111111111111","key":"payment[card_number]","type":"text","disabled":true},{"value":"12","key":"payment[card_exp_month]","type":"text","disabled":true},{"value":"2027","key":"payment[card_exp_year]","type":"text","disabled":true},{"value":"123","key":"payment[card_cvv]","type":"text","description":"Required for method=card. With method=onfile, supply only this to charge the card on file with a CVV.
\n","disabled":true},{"value":"123 Main St","key":"payment[billing_address][address1]","type":"text","disabled":true},{"value":"Apt 4B","key":"payment[billing_address][address2]","type":"text","disabled":true},{"value":"New York","key":"payment[billing_address][city]","type":"text","disabled":true},{"value":"NY","key":"payment[billing_address][state]","type":"text","disabled":true},{"value":"10001","key":"payment[billing_address][postal_code]","type":"text","disabled":true},{"value":"US","key":"payment[billing_address][country]","type":"text","disabled":true}]},"url":"https://api.sparkcrm.io/checkout/orders/upsell","description":"Process a transaction as an upsell for an existing order from within the CRM
\nBearer Token from collection Spark CRM
\nBy default (no payment object) the upsell is charged to the card on file from the original order — no card data required.
payment[method]=onfile together with payment[card_cvv]. The saved card is charged and the supplied CVV is forwarded to the gateway. Useful for gateways that require a CVV on every charge.payment[method]=card with the full card fields. A card on file matching the supplied number is reused (CVV/expiry refreshed); a different number is added as a new card. The supplied card is promoted to the customer's primary card only after the charge is approved, so a declined upsell never reroutes future subscription rebills onto an unvalidated card.Guardrails (return 422):
Two ways to populate the upsell's tax:
\ntax_amount (and optionally tax_rate) in the request body. Typical flow: call POST /checkout/tax with the upsell's line items to get the calculated tax, then pass the returned value here. The customer is charged the tax_amount you supply.CampaignUpsell.tax_rate configured on the offer.Each upsell posts to TaxJar as its own record. When the upsell transaction completes, it's posted to TaxJar's /v2/transactions/orders endpoint keyed by the transaction's ID. Refunds of this upsell will reference that specific transaction — so tax reporting stays accurate even when items in the same order have different tax treatments (e.g., taxable base + tax-exempt clothing upsell).
Charge vs. report are separate decisions:
\ntax_amount controls what the customer pays.tax_enabled flag + active provider. If the campaign has tax disabled, the customer is still charged the supplied tax_amount, but nothing is reported to TaxJar's books.Mark an order as completed within the CRM.
\nNote: By default, this endpoint will be called 20 minutes after the customers last transaction which will close the order and send any applicable transactional emails
\nBearer Token from collection Spark CRM
\nRetry a payment attempt on a previously declined order. This endpoint allows merchants to reprocess payment using the existing order configuration, or override specific parameters such as amount, gateway, payment method, billing address, affiliate, or sub affiliate IDs.
\nBearer Token from collection Spark CRM
\nRequired Permission: api:orders.payment.reprocess
declined, failed, error, pending, expired, or abandoned can be retried. All other statuses return an error.gateway_id and payment_orchestrator_id are provided, gateway_id takes precedence. A system note is logged on the order indicating the orchestrator was ignored.amount is not provided, the system uses the amount from the most recent payment attempt. If no prior transaction exists, the cart total is used.payment.method is not provided, the system reuses the payment method from the most recent transaction on the order.\"none\" to remove the affiliate. Pass a valid affiliate identifier to change it. Invalid values are ignored and a system note is logged.sub1–sub5) is optional and only updates the order when supplied. Pass an empty string to clear that sub affiliate ID. Omitted fields leave the existing value unchanged. The longer-form aliases sub_affiliate_id, sub_affiliate_id_2, sub_affiliate_id_3, sub_affiliate_id_4, and sub_affiliate_id_5 are also accepted. When any sub IDs change, a system note is logged on the order listing the columns that were updated.The endpoint accepts both initial orders and subscription rebill orders (each rebill is a separate order linked to its subscription). When the order being reprocessed is a rebill and the retry succeeds, the parent subscription is updated to match a first-try successful rebill:
\npast_due, salvaging, or declined_out back to active (or completed if the subscription has reached total_cycles). Subscriptions already in active stay active.billing_cycle and successful_cycles are incremented.last_billed_at is set to now and next_billing_at is advanced by billing_interval days.total_billed and total_paid are increased by subscription.total.retry_count is reset to 0.completed (instead of stopping at processing).SubscriptionUpdatedEvent is fired and a system note is added to the order.On a failed retry, the subscription is not touched by this endpoint — the existing subscription salvage / retry pipeline owns that state.
\nCaptures a PayPal Wallet payment after the customer has approved it on PayPal. This is the final step in the PayPal redirect flow.
\nThis endpoint is idempotent — if the payment has already been captured, it will return the current state without charging again.
\npayment.method set to \"paypal_wallet\". You receive a redirect_url in the response.redirect_url. They approve the payment on PayPal and are redirected back to your return_url.order_number to finalize the charge. Money does not move until this step completes.Bearer Token from collection Spark CRM
\nReturn information about orders that match the specified search criteria from within the CRM
\nBearer Token from collection Spark CRM
\nPage number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"b2399e2d-2973-47b7-a7ca-9dd7f2cfdd70","name":"Search Orders Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer[email]","value":"test@example.com","type":"text"},{"key":"customer[first_name]","value":"John","type":"text"},{"key":"customer[last_name]","value":"Doe","type":"text"},{"key":"customer[phone]","value":"5551234567","type":"text"},{"key":"shipping[address1]","value":"123 Main St","type":"text"},{"key":"shipping[address2]","value":"Apt 4B","type":"text"},{"key":"shipping[city]","value":"New York","type":"text"},{"key":"shipping[state]","value":"NY","type":"text"},{"key":"shipping[postal_code]","value":"10001","type":"text"},{"key":"shipping[country]","value":"US","type":"text"},{"key":"campaign_id","value":"1","type":"text"},{"key":"currency","value":"USD","type":"text"},{"key":"utm_source","value":"google","type":"text"},{"key":"utm_medium","value":"cpc","type":"text"},{"key":"utm_campaign","value":"summer_sale","type":"text"},{"key":"utm_term","value":"best deals","type":"text"},{"key":"utm_content","value":"banner1","type":"text"},{"key":"affiliate_id","value":"AFF123","type":"text"},{"key":"sub_affiliate_id","value":"SUB456","type":"text"},{"key":"products[0][offer_id]","value":"1","type":"text"},{"key":"products[0][quantity]","value":"1","type":"text"},{"key":"products[1][offer_id]","value":"2","type":"text"},{"key":"products[1][quantity]","value":"1","type":"text"},{"key":"ip_address","value":"192.168.1.1","type":"text"},{"key":"user_agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36","type":"text"}]},"url":{"raw":"https://api.sparkcrm.io/checkout/orders?order_number=ORD-250321-00001&date_start=2023-01-01&date_end=2025-12-31&per_page=20","protocol":"https","host":["api","sparkcrm","io"],"path":["checkout","orders"],"query":[{"key":"order_number","value":"ORD-250321-00001"},{"key":"customer_number","value":"CUST-230315-00001","type":"text","disabled":true},{"key":"customer_email","value":"john.doe@example.com","type":"text","disabled":true},{"key":"customer_phone","value":"5551234567","type":"text","disabled":true},{"key":"customer_name","value":"John Doe","type":"text","disabled":true},{"key":"status","value":"processing","type":"text","disabled":true},{"key":"date_start","value":"2023-01-01"},{"key":"date_end","value":"2025-12-31"},{"key":"per_page","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Mar 2025 02:21:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"CF-RAY","value":"9239fa083e7c72eb-ORD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"customer_number\": \"CUST-250529-00001\",\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"full_name\": \"Test Test\",\n \"email\": \"johndoe@gmail.com\",\n \"phone\": \"4444444444\",\n \"created_at\": \"2025-05-29 14:56:53\",\n \"orders\": [\n {\n \"order_number\": \"ORD-250529-00001\",\n \"campaign_name\": \"Summer Health Promo\",\n \"campaign_id\": \"3\",\n \"affiliate_name\": \"HealthAds Network\",\n \"affiliate_id\": \"AFF-001\",\n \"sub1\": \"landing_v2\",\n \"sub2\": \"banner_top\",\n \"sub3\": null,\n \"sub4\": null,\n \"sub5\": null,\n \"utm_source\": \"google\",\n \"utm_medium\": \"cpc\",\n \"utm_campaign\": \"summer_sale\",\n \"utm_term\": \"best deals\",\n \"utm_content\": \"banner1\",\n \"custom_fields\": {\n \"partner_ref\": \"ACME-2024-Q4\",\n \"landing_variant\": \"hero-v3\"\n },\n \"status\": \"completed\",\n \"currency\": \"USD\",\n \"is_throttled\": false,\n \"created_at\": \"2025-05-29 14:56:53\",\n \"transactions\": [\n {\n \"transaction_number\": \"TXN-250529-000001\",\n \"campaign_name\": \"Summer Health Promo\",\n \"campaign_id\": \"3\",\n \"gateway_name\": \"NMI Production\",\n \"gateway_id\": \"5\",\n \"external_transaction_id\": \"SANDBOX-8E02E190-55B4-45FC-BAEB-05D141613532\",\n \"status\": \"completed\",\n \"amount\": \"270.00\",\n \"currency\": \"USD\",\n \"payment_method\": \"card\",\n \"affiliate_name\": \"HealthAds Network\",\n \"affiliate_id\": \"AFF-001\",\n \"sub1\": \"landing_v2\",\n \"sub2\": \"banner_top\",\n \"sub3\": null,\n \"sub4\": null,\n \"sub5\": null,\n \"utm_source\": \"google\",\n \"utm_medium\": \"cpc\",\n \"utm_campaign\": \"summer_sale\",\n \"utm_term\": \"best deals\",\n \"utm_content\": \"banner1\",\n \"card_brand\": \"Visa\",\n \"card_first_six\": \"411111\",\n \"card_last_four\": \"1111\",\n \"is_upsell\": false,\n \"upsell_depth\": 0,\n \"gateway_response\": \"Sandbox: Transaction approved\",\n \"decline_code\": null,\n \"is_reprocessable\": false,\n \"created_at\": \"2025-05-29 14:56:53\",\n \"updated_at\": \"2025-05-29 14:56:53\",\n \"products\": [\n {\n \"id\": 9,\n \"name\": \"Restore - 6 Bottles\",\n \"type\": \"offer\"\n }\n ]\n }\n ],\n \"cart\": {\n \"tax\": \"0.00\",\n \"items\": [\n {\n \"quantity\": 1,\n \"name\": \"Restore - 6 Bottles\",\n \"unit_price\": 270,\n \"shipping_price\": 0,\n \"subtotal\": 270,\n \"tax\": 0,\n \"is_upsell\": false,\n \"id\": 9,\n \"type\": \"offer\"\n }\n ],\n \"total\": \"270.00\",\n \"shipping\": \"0.00\",\n \"subtotal\": \"270.00\"\n }\n }\n ],\n \"addresses\": [\n {\n \"name\": \"Test Test\",\n \"street_1\": \"123 testing\",\n \"street_2\": \"\",\n \"city\": \"test\",\n \"state_province\": \"AL\",\n \"postal_code\": \"55555\",\n \"country_code\": \"US\",\n \"phone\": \"\",\n \"email\": \"johndoe@gmail.com\",\n \"type\": \"home\",\n \"is_primary\": true,\n \"is_billing\": true,\n \"is_shipping\": true\n }\n ]\n }\n ],\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 20,\n \"current_page\": 1,\n \"last_page\": 1\n }\n}"}],"_postman_id":"29ea9eb6-7169-4d28-9360-87a1e8901f8f"},{"name":"Calculate Tax","id":"4c9e9410-6d0c-4f56-3e62-5937e40538ec","request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"campaign_id","value":"1"},{"type":"text","key":"shipping","value":"4.70"},{"type":"text","key":"to_address[country]","value":"US"},{"type":"text","key":"to_address[zip]","value":"90001"},{"type":"text","key":"to_address[state]","value":"CA"},{"type":"text","key":"to_address[city]","value":"Los Angeles"},{"type":"text","key":"to_address[street]","value":"123 Main St"},{"type":"text","key":"line_items[0][sku]","value":"SKU-001"},{"type":"text","key":"line_items[0][quantity]","value":"1"},{"type":"text","key":"line_items[0][unit_price]","value":"49.98"},{"type":"text","key":"line_items[0][tax_code]","value":"20010","disabled":true},{"type":"text","key":"line_items[1][sku]","value":"SKU-002","disabled":true},{"type":"text","key":"line_items[1][quantity]","value":"2","disabled":true},{"type":"text","key":"line_items[1][unit_price]","value":"29.99","disabled":true},{"type":"text","key":"line_items[1][tax_code]","value":"40030","disabled":true}]},"url":"https://api.sparkcrm.io/checkout/tax","description":"Calculates sales tax for a cart in real time via the campaign's configured tax provider (TaxJar). Intended to be called during checkout whenever the cart or shipping address changes, so the tax amount displayed to the customer stays in sync with the line items and destination.
\nIf the campaign has no tax provider configured, is disabled, or the provider is inactive, the endpoint returns tax_amount: 0, tax_rate: 0, empty breakdown, and tax_enabled: false. Callers should treat that as a successful \"no tax required\" response rather than an error.
Bearer Token from collection Spark CRM. The API key must have the api:tax.calculate permission.
{\n \"success\": true,\n \"data\": {\n \"tax_amount\": 4.37,\n \"tax_rate\": 0.0875,\n \"breakdown\": {\n \"state\": 3.00,\n \"county\": 0.50,\n \"city\": 0.50,\n \"special\": 0.37\n },\n \"tax_enabled\": true\n }\n}\n{\n \"success\": true,\n \"data\": {\n \"tax_amount\": 0,\n \"tax_rate\": 0,\n \"breakdown\": [],\n \"tax_enabled\": false\n }\n}\nTaxJar exposes a taxonomy of product categories that alter per-jurisdiction taxability (clothing is exempt in PA but taxable in CA, groceries are reduced-rate in many states, prescriptions are exempt nearly everywhere, etc.).
\ntax_code to treat the item as fully taxable — TaxJar's default.tax_code to let TaxJar consult ship-from / ship-to / local rules for that category.GET /v2/categories in the TaxJar API.tax_amount can be passed back to POST /checkout/orders as tax_amount (and optionally tax_rate) to lock in the calculated value. The Order endpoints will otherwise recompute tax server-side when the campaign has tax enabled.Retry a previously declined, failed, or errored upsell transaction. The endpoint re-charges the same upsell product on the existing order — optionally through a different gateway or with a fresh payment method.
\nTarget the attempt to retry with the transaction_number of a declined upsell, as surfaced by Search Orders / Search Transactions (where is_reprocessable is true).
Bearer Token from collection Spark CRM
\nRequired Permission: api:orders.upsell.reprocess
declined, failed, or error can be reprocessed. Non-upsell (main) transactions and already-approved transactions are rejected.gateway_id (or payment_orchestrator_id) to force the retry through a specific gateway, overriding the upsell's stored gateway. If neither is provided, the upsell's configured gateway (offer gateway / upsell gateway / campaign default) is used. When both are provided, gateway_id wins.payment block to charge a new card or a saved (onfile) method. If omitted, the payment method from the declined upsell is reused.409.max_reprocess_attempts_per_decline, reprocessing is blocked once that many retries exist for the decline lineage.Here are example offers and how you would interract with the endpoints:
\nMultiple Step Form with Upsells (Capture lead and then capture card information):
Create Lead -> Process Payment -> Process Upsell #1 -> Process Upsell #2 -> Complete Order (optional)
Single Checkout Form with Upsells (Capture lead and card information in one form):
Create Order -> Process Upsell #1 -> Process Upsell #2 -> Complete Order (optional)
Note: The Create Order endpoint is a stand-alone order creation for 1-step checkouts.
Where as the Create Lead and Process Payment endpoint are paired together for 2-step checkouts
Return payment transactions that match the specified search criteria from within the CRM
\nBearer Token from collection Spark CRM
\nPage number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"e820ad3d-f953-4068-8498-c7854a52007e","name":"Search Transactions Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"customer[email]","value":"test@example.com","type":"text"},{"key":"customer[first_name]","value":"John","type":"text"},{"key":"customer[last_name]","value":"Doe","type":"text"},{"key":"customer[phone]","value":"5551234567","type":"text"},{"key":"shipping[address1]","value":"123 Main St","type":"text"},{"key":"shipping[address2]","value":"Apt 4B","type":"text"},{"key":"shipping[city]","value":"New York","type":"text"},{"key":"shipping[state]","value":"NY","type":"text"},{"key":"shipping[postal_code]","value":"10001","type":"text"},{"key":"shipping[country]","value":"US","type":"text"},{"key":"campaign_id","value":"1","type":"text"},{"key":"currency","value":"USD","type":"text"},{"key":"utm_source","value":"google","type":"text"},{"key":"utm_medium","value":"cpc","type":"text"},{"key":"utm_campaign","value":"summer_sale","type":"text"},{"key":"utm_term","value":"best deals","type":"text"},{"key":"utm_content","value":"banner1","type":"text"},{"key":"affiliate_id","value":"AFF123","type":"text"},{"key":"sub_affiliate_id","value":"SUB456","type":"text"},{"key":"products[0][offer_id]","value":"1","type":"text"},{"key":"products[0][quantity]","value":"1","type":"text"},{"key":"products[1][offer_id]","value":"2","type":"text"},{"key":"products[1][quantity]","value":"1","type":"text"},{"key":"ip_address","value":"192.168.1.1","type":"text"},{"key":"user_agent","value":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36","type":"text"}]},"url":{"raw":"https://api.sparkcrm.io/checkout/transactions?transaction_number=TXN-250321-000002&date_start=2025-01-01&date_end=2025-03-22&per_page=10","protocol":"https","host":["api","sparkcrm","io"],"path":["checkout","transactions"],"query":[{"key":"transaction_number","value":"TXN-250321-000002"},{"key":"external_transaction_id","value":"12345ABC","type":"text","disabled":true},{"key":"order_number","value":"ORD-250315-00010","type":"text","disabled":true},{"key":"customer_number","value":"CUST-250315-00005","type":"text","disabled":true},{"key":"customer_email","value":"test@example.com","disabled":true},{"key":"status","value":"completed","type":"text","disabled":true},{"key":"date_start","value":"2025-01-01"},{"key":"date_end","value":"2025-03-22"},{"key":"per_page","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Mar 2025 02:20:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"cloudflare"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Cf-Cache-Status","value":"DYNAMIC"},{"key":"Content-Encoding","value":"br"},{"key":"CF-RAY","value":"9239f8b72c7f72eb-ORD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"customer_number\": \"CUST-250529-00001\",\n \"order_number\": \"ORD-250529-00001\",\n \"transaction_number\": \"TXN-250529-000001\",\n \"campaign_name\": \"Summer Health Promo\",\n \"campaign_id\": \"3\",\n \"gateway_name\": \"NMI Production\",\n \"gateway_id\": \"5\",\n \"external_transaction_id\": \"SANDBOX-8E02E190-55B4-45FC-BAEB-05D141613532\",\n \"status\": \"completed\",\n \"amount\": \"270.00\",\n \"currency\": \"USD\",\n \"payment_method\": \"card\",\n \"affiliate_name\": \"HealthAds Network\",\n \"affiliate_id\": \"AFF-001\",\n \"sub1\": \"landing_v2\",\n \"sub2\": \"banner_top\",\n \"sub3\": null,\n \"sub4\": null,\n \"sub5\": null,\n \"utm_source\": \"google\",\n \"utm_medium\": \"cpc\",\n \"utm_campaign\": \"summer_sale\",\n \"utm_term\": \"best deals\",\n \"utm_content\": \"banner1\",\n \"card_brand\": \"Visa\",\n \"card_first_six\": \"411111\",\n \"card_last_four\": \"1111\",\n \"is_upsell\": false,\n \"upsell_depth\": 0,\n \"gateway_response\": \"Sandbox: Transaction approved\",\n \"decline_code\": null,\n \"is_reprocessable\": false,\n \"created_at\": \"2025-05-29 14:56:53\",\n \"updated_at\": \"2025-05-29 14:56:53\",\n \"products\": [\n {\n \"id\": 9,\n \"name\": \"Restore - 6 Bottles\",\n \"type\": \"offer\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 1\n }\n}"}],"_postman_id":"5a42b160-6ff8-4d55-94f3-d84c32b50d2d"},{"name":"Refund Transaction","id":"681718e6-d47d-4005-9495-d3b209b4cbfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"transaction_number","value":"TXN-250321-000002","type":"text"},{"key":"amount","value":"25.00","type":"text","disabled":true},{"key":"is_external","value":"false","type":"text"},{"key":"refund_reason","value":"Customer dissatisfied with product","type":"text"}]},"url":"https://api.sparkcrm.io/checkout/transactions/refund","description":"Process a refund for a specific transaction from within the CRM
\nBearer Token from collection Spark CRM
\nWhen a refund is processed on an order whose campaign has TaxJar enabled and whose original order was posted to TaxJar, a matching refund transaction is automatically posted to TaxJar's /v2/transactions/refunds endpoint. No additional request fields are required — tax handling is driven by the campaign's tax provider configuration and the order's original TaxJar transaction.
Proration: The refund's tax and shipping portions are prorated by refund_amount / order_total against the original order's tax and shipping. Example — refunding $59.38 of a $118.75 order (50%) posts sales_tax: -4.38 against the original sales_tax: 8.75.
Coverage:
\nOrderVoidedEvent) on TaxJar-posted orders — sent as a full-amount negative refund.is_external: true) — still posted since TaxJar tracks tax liability regardless of money movement.ProcessAlertRefundAction.Idempotency: Each refund is posted with a stable transaction_id of \"{order_id}-refund-{transaction_id}\" and a transaction_reference_id linking to the original order. Duplicate posts (422) are treated as success. The transactions.tax_posted_at timestamp marks which refund rows have been posted.
Skipped cases: Orders without a TaxJar provider, with tax_enabled: false, or that were never posted to TaxJar (orders.tax_posted_at null) — nothing is sent in these cases.
Mark an existing transaction as a chargeback from within the CRM.
\nThis endpoint records a chargeback against the original transaction — it creates a new negative-amount transaction linked to the original and sets the order status to chargeback. It does not issue a refund. The original transaction is left intact for record keeping. Use this when a chargeback has occurred outside the system (for example, reported by your processor) and you need to reflect it in the CRM.
As part of marking the chargeback, the customer's active subscriptions are cancelled and the customer is added to the blacklist.
\nBearer Token from collection Spark CRM
\nRequires the api:transactions.chargeback token permission.
completed status; a new linked transaction with status chargeback and a negative amount is created for record keeping.chargeback.Sanity check whether a customer currently has an active subscription. Designed for 3rd-party subscription managers to confirm presence before attempting to bill or before submitting a new external subscription order.
\nAccepts either an order_id (resolved up to the customer) or a customer_id directly. Exactly one of the two must be provided.
Bearer Token with permission: api:subscriptions.check_status (or the legacy api:view_any ability)
A customer can have multiple active subscriptions. The response always returns the full list, plus a subscription_number convenience field for callers that only care about the most recent one.
Single active subscription
\n{\n \"active\": true,\n \"active_count\": 1,\n \"customer_number\": \"CUST-251104-0001\",\n \"subscription_numbers\": [\"SUB-251104-0001\"],\n \"subscription_number\": \"SUB-251104-0001\"\n}\nMultiple active subscriptions
\n{\n \"active\": true,\n \"active_count\": 2,\n \"customer_number\": \"CUST-251104-0001\",\n \"subscription_numbers\": [\"SUB-251104-0007\", \"SUB-251104-0001\"],\n \"subscription_number\": \"SUB-251104-0007\"\n}\nCustomer or order not found / no active subscription
\n{\n \"active\": false,\n \"active_count\": 0,\n \"customer_number\": null,\n \"subscription_numbers\": [],\n \"subscription_number\": null\n}\nsubscription_numbers if you need to disambiguate.200 OK even when nothing is found; a 4xx is only returned for auth/validation failures.Order number to resolve up to the customer. Use either order_id or customer_id (one is required).
\n","type":"text/plain"},"key":"order_id","value":"ORD-251104-0001"},{"disabled":true,"description":{"content":"Customer number to look up directly. Use either order_id or customer_id (one is required).
\n","type":"text/plain"},"key":"customer_id","value":"CUST-251104-0001"}],"variable":[]}},"response":[],"_postman_id":"4be79cf8-b036-544a-656d-80339cda6205"},{"name":"Process Subscription","id":"1bf6ff3f-bd37-c9c6-5b24-736a89857215","request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"subscription_id","value":"SUB-251104-0001","description":"Subscription number or UUID to bill now
\n"},{"key":"gateway_id","type":"text","value":"12","description":"Override the configured gateway
\n","disabled":true},{"key":"payment_orchestrator_id","type":"text","value":"3","description":"Override the configured payment orchestrator
\n","disabled":true},{"key":"price","type":"text","value":"29.99","description":"Override the recurring price for this billing only
\n","disabled":true},{"key":"payment[card][number]","type":"text","value":"4111111111111111","description":"Override the on-file card with a new card for this billing
\n","disabled":true},{"key":"payment[card][exp_month]","type":"text","value":"12","description":"Required when payment[card][number] is provided
\n","disabled":true},{"key":"payment[card][exp_year]","type":"text","value":"2030","description":"Required when payment[card][number] is provided
\n","disabled":true},{"key":"payment[card][cvv]","type":"text","value":"123","description":"Optional CVV for the override card
\n","disabled":true},{"type":"text","key":"billing_address[first_name]","value":"George","disabled":true},{"type":"text","key":"billing_address[last_name]","value":"Foreman","disabled":true},{"type":"text","key":"billing_address[address1]","value":"123 Main St","disabled":true},{"type":"text","key":"billing_address[city]","value":"Los Angeles","disabled":true},{"type":"text","key":"billing_address[state]","value":"CA","disabled":true},{"type":"text","key":"billing_address[zip]","value":"90001","disabled":true},{"type":"text","key":"billing_address[country]","value":"US","disabled":true}]},"url":"https://api.sparkcrm.io/checkout/subscriptions/process","description":"Trigger an immediate billing run on an existing subscription, optionally overriding the gateway, payment orchestrator, price, payment card, or billing address for this billing only. Lets a 3rd-party subscription manager bill on their own schedule, overriding the platform's scheduling for that subscription.
\nThe subscription must be in an active or trial status; canceled/paused/failed subscriptions are rejected.
Bearer Token with permission: api:subscriptions.process
On success (200 OK)
On non-billable result (422 Unprocessable Entity)
payment[card][number] is provided, it is used in place of the customer's on-file payment method for this charge.This simplified API streamlines the checkout process for developers. Designed with ease of use in mind, Spark CRM API reduces complexity and allows you to implement checkout functionality with minimal code requirements. The streamlined interface focuses on essential operations, making integration straightforward while maintaining robust functionality.
\nRegister for a Spark CRM account to get started
\nLogin to your Spark Account
\nNavigate to Settings > API Keys
\nClick \"Generate API Key\"
\nCopy your newly generated API key
\nStore this key securely - it will only be shown once
\nInclude your API key in all requests as a Bearer token in the Authorization header:
\nAuthorization: Bearer YOUR_API_KEY_HERE
All authenticated endpoints require this header to be present with a valid API key.
\nThis is a JSON API and requires proper headers for all requests:
\nAll requests must include Content-Type: application/json
All requests must include Accept: application/json
If these headers are not included, the API will return a 400 Bad Request response with an error message indicating which header is missing or incorrect, such as \"Content-Type must be application/json\" or \"Accept must be application/json\".
\nTo ensure system stability and fair usage, API requests are subject to the below rate limiting per account:
\n100 requests per minute is default
\nEnterprise accounts can be set to custom rate limits (e.g. 1,000 requests per minute and beyond). To increase rate limits please email hello@sparkcrm.io.
\nWhen a rate limit is exceeded, the API will return a 429 Too Many Requests response with the following headers:
\nSpark CRM uses conventional HTTP response codes to indicate the success or failure of an API request. In general:
\nCodes in the 2xx range indicate success
Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, invalid object passed, etc.)
Codes in the 5xx range indicate an error with Spark CRM's servers (these are rare)
All 4xx and 5xx errors return an error message via the \"errors\" field.
{\n \"success\": false,\n \"message\": \"Validation error\",\n \"errors\": {\n \"customer.email\": [\n \"The email field is required.\"\n ],\n \"shipping.address1\": [\n \"The address1 field is required.\"\n ]\n }\n}\n\nIf there is no data for a response field, the API will use null for that field's value.
Retrieve every offer attached to a campaign, ordered by display position.
\nReturns the full list of offers configured for a single campaign. Offers are the primary purchasable items of a campaign (the \"core\" products) and are always returned sorted by their position (ascending). This endpoint returns the summary shape of each offer; the bundle_products array is only included on the create and update endpoints (the detailed shape).
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.offers.view
This endpoint takes no query parameters or request body. Results are not paginated and are always ordered by position ascending.
Returns success: true and a data array. Each element is a campaign offer:
GET /v1/campaigns/123/offers
Returns the campaign's offers ordered by position.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","name":"Spark CRM","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","campaigns","123","offers"],"host":["api","sparkcrm","io"],"query":[],"variable":[]}},"response":[{"id":"15fe1305-5593-bafc-7c03-25515d819c90","name":"List Campaign Offers","originalRequest":{"method":"GET","header":[],"url":"https://api.sparkcrm.io/v1/campaigns/123/offers","description":"# List Campaign Offers\n\n**Retrieve every offer attached to a campaign, ordered by display position.**\n\nReturns the full list of offers configured for a single campaign. Offers are the primary purchasable items of a campaign (the \"core\" products) and are always returned sorted by their `position` (ascending). This endpoint returns the summary shape of each offer; the `bundle_products` array is only included on the create and update endpoints (the detailed shape).\n\n## Authorization\n\nBearer Token from collection Spark CRM\n\n**Required permission:** `api:campaigns.offers.view`\n\n## Request Object\n\n| Request Field | Description |\n| --- | --- |\n| `identifier` | _**string (required)**_ Path parameter. The campaign's `internal_id` (the public id of the campaign, e.g. `123`). Must belong to the authenticated team or a `404 Campaign not found` is returned. Matches the pattern `[a-zA-Z0-9\\-_]+`. |\n\nThis endpoint takes no query parameters or request body. Results are not paginated and are always ordered by `position` ascending.\n\n## Response Object\n\nReturns `success: true` and a `data` array. Each element is a campaign offer:\n\n| Field | Description |\n| --- | --- |\n| `id` | The offer's `internal_id` (use this value as `{offer_id}` for update/delete). |\n| `name` | The offer name. |\n| `is_active` | Boolean. Whether the offer is active. |\n| `position` | Integer display/sort order. |\n| `price` | Decimal string with 2 places, e.g. `\"49.95\"`. |\n| `shipping_price` | Decimal string with 2 places. |\n| `tax_rate` | Decimal string with 2 places (percentage). |\n| `is_tax_included` | Boolean. When `true`, `tax_rate` is treated as already baked into `price`. |\n| `dynamic_descriptor` | The billing descriptor shown on the customer's statement, or `null`. |\n| `sale_type` | One of `none`, `standard`, `trial`, `installment`, `custom`, `third_party`, or `null`. |\n| `subscription_config` | Object/array of subscription settings, or `null`. |\n| `product_id` | The primary product's `internal_id` (the product charged as the single line item). |\n| `created_at` | ISO-8601 timestamp. |\n| `updated_at` | ISO-8601 timestamp. |\n\n## Errors\n\n| Status | Meaning |\n| --- | --- |\n| `403` | Token lacks the `api:campaigns.offers.view` (or legacy `api:view_any`) permission. |\n| `404` | Campaign not found for this team. |\n\n## Example\n\n`GET /v1/campaigns/123/offers`\n\nReturns the campaign's offers ordered by position."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 4501,\n \"name\": \"Premium Skin Cream - Buy 1\",\n \"is_active\": true,\n \"position\": 0,\n \"price\": \"49.95\",\n \"shipping_price\": \"5.99\",\n \"tax_rate\": \"0.00\",\n \"is_tax_included\": false,\n \"dynamic_descriptor\": \"SPARK*SKINCARE\",\n \"sale_type\": \"standard\",\n \"subscription_config\": {\n \"interval\": \"month\",\n \"interval_count\": 1\n },\n \"product_id\": 781,\n \"created_at\": \"2026-05-02T14:21:08.000000Z\",\n \"updated_at\": \"2026-06-10T09:03:55.000000Z\"\n },\n {\n \"id\": 4502,\n \"name\": \"Premium Skin Cream - Buy 3 Bundle\",\n \"is_active\": true,\n \"position\": 1,\n \"price\": \"119.95\",\n \"shipping_price\": \"0.00\",\n \"tax_rate\": \"7.50\",\n \"is_tax_included\": false,\n \"dynamic_descriptor\": \"SPARK*SKINCARE\",\n \"sale_type\": \"none\",\n \"subscription_config\": null,\n \"product_id\": 781,\n \"created_at\": \"2026-05-02T14:25:40.000000Z\",\n \"updated_at\": \"2026-05-02T14:25:40.000000Z\"\n }\n ]\n}"}],"_postman_id":"bd3276cb-2f1b-294f-9ca8-60752facd33b"},{"name":"Create Campaign Offer","id":"5c72471c-6949-8345-49c0-d5e5cf221fe5","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"product_id\": 781,\n \"name\": \"Premium Skin Cream - Buy 3 Bundle\",\n \"is_active\": true,\n \"position\": 1,\n \"price\": 119.95,\n \"shipping_price\": 0,\n \"tax_rate\": 7.5,\n \"is_tax_included\": false,\n \"dynamic_descriptor\": \"SPARK*SKINCARE\",\n \"sale_type\": \"standard\",\n \"subscription_config\": {\n \"interval\": \"month\",\n \"interval_count\": 1\n },\n \"bundle_products\": [\n {\n \"product_id\": 781,\n \"quantity\": 2,\n \"position\": 0\n },\n {\n \"product_id\": 802,\n \"quantity\": 1,\n \"position\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparkcrm.io/v1/campaigns/123/offers","description":"Add a new purchasable offer to a campaign, optionally as a multi-product bundle.
\nCreates an offer within the given campaign. An offer is charged as a single line item against its primary product_id, but you may optionally attach bundle_products - the set of underlying products that are actually shipped to fulfillment when the offer is purchased. Supplying more than one bundle product makes the offer a bundle. The response uses the detailed shape, so the persisted bundle_products are echoed back.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.offers.create
Returns success: true, a message of Offer created successfully, and a data object using the detailed offer shape. In addition to the standard offer fields (see List Campaign Offers), the detailed shape includes a bundle_products array, each element containing product_id (the product's internal_id), name, quantity, and position.
POST /v1/campaigns/123/offers with the request body above creates a bundle offer and returns the 201 payload shown in the response.
Update an existing campaign offer; all fields are optional (partial update).
\nUpdates a single offer within a campaign, identified by its internal_id in the path. This is a PATCH, so every field is optional - only the fields you send are validated and changed. If bundle_products is included it fully replaces (syncs) the offer's existing bundle set; omit it to leave the current bundle untouched.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.offers.update
All fields are optional. A field is only validated when present (sometimes).
Returns success: true, a message of Offer updated successfully, and a data object in the detailed offer shape, including the bundle_products array (each entry with product_id, name, quantity, position).
PATCH /v1/campaigns/123/offers/4502 with a partial body updates only the supplied fields and re-syncs the bundle when bundle_products is present.
Soft-delete an offer from a campaign.
\nRemoves an offer from the given campaign. The offer is soft-deleted (the underlying model uses soft deletes), so it is hidden from listings but retained in the database. The campaign and offer must both belong to the authenticated team.
\nBearer Token from collection Spark CRM
\nRequired permission: api:campaigns.offers.delete
This endpoint takes no request body.
\nReturns success: true with a message of Offer deleted successfully.
DELETE /v1/campaigns/123/offers/4502 soft-deletes the offer and returns the success message.
Returns every upsell assigned to a campaign, ordered by display position.
\nRetrieves the full list of upsells configured on a single campaign. Upsells are post-purchase offers presented after the core sale; each one references a primary product and may bundle multiple shippable products. Results are scoped to your team and sorted ascending by position.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.upsells.view
This endpoint takes no query parameters. It always returns the complete, unpaginated set of upsells for the campaign.
\nReturns success: true and a data array. Each element is the base upsell representation:
Note: gateway / payment router / bundle fields are only returned by the create and update endpoints (the detailed representation), not by this list.
\nGET /v1/campaigns/123/upsells
Adds a new post-purchase upsell to a campaign.
\nCreates an upsell on the given campaign. The upsell references a primary product_id (the single line that is charged) and may optionally define bundle_products (the underlying products sent to fulfillment when the upsell is taken). All product, gateway and payment-router ids are supplied as internal ids and are resolved to your team's records server-side.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.upsells.create
Returns 201 with success: true, a message, and a data object using the detailed representation. In addition to the base fields it includes use_offer_gateway, gateway_id (resolved back to the gateway internal id), payment_orchestrator_id (resolved back to the router internal id), and a bundle_products array (product_id, name, quantity, position).
POST /v1/campaigns/123/upsells with the request body shown above.
Return every affiliate assigned to a campaign along with its payout configuration.
\nReturns the full list of affiliate assignments for the specified campaign, ordered by most recently assigned first. Each item includes the affiliate identity plus the payout rules (type, rates, exclusions) configured for that affiliate on this campaign. Results are scoped to the authenticated team and are not paginated.
\nBearer Token from collection Spark CRM
\nRequired permission: api:campaigns.affiliates.view
This endpoint takes no query parameters and is not paginated; it returns every assignment for the campaign.
\nReturns success: true and a data array. Each element of data[] represents one campaign-affiliate assignment:
Request
\nGET https://api.sparkcrm.io/v1/campaigns/123/affiliates
Response 200 OK
{\n \"data\": [\n {\n \"affiliate_id\": \"AFF-1001\",\n \"affiliate_name\": \"Acme Media\",\n \"is_active\": true,\n \"payout_type\": \"percentage\",\n \"flat_rate\": null,\n \"percentage_rate\": \"30.00\",\n \"tiered_rates\": null,\n \"custom_rules\": null,\n \"pay_on_offer_purchase\": true,\n \"pay_on_upsell_purchase\": false,\n \"excluded_products\": [],\n \"excluded_countries\": [\"CA\"],\n \"created_at\": \"2026-06-16T14:22:05.000000Z\",\n \"updated_at\": \"2026-06-16T14:22:05.000000Z\"\n }\n ],\n \"success\": true\n}\nAttach an affiliate to a campaign and define how that affiliate is paid.
\nCreates a new campaign-affiliate assignment linking an existing affiliate (referenced by its custom_id) to the campaign, together with its payout configuration. The affiliate must already exist for the authenticated team, and the same affiliate cannot be assigned to the campaign more than once.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.affiliates.assign
Returns 201 Created with success: true, a message, and a data object representing the newly created assignment (see the List endpoint for the full field list). Decimal rate fields are returned as 2-dp strings (e.g. \"30.00\").
Request
\nPOST https://api.sparkcrm.io/v1/campaigns/123/affiliates
{\n \"affiliate_id\": \"AFF-1001\",\n \"is_active\": true,\n \"payout_type\": \"percentage\",\n \"percentage_rate\": 30,\n \"pay_on_offer_purchase\": true,\n \"pay_on_upsell_purchase\": false,\n \"excluded_countries\": [\"CA\"]\n}\nResponse 201 Created
{\n \"data\": {\n \"affiliate_id\": \"AFF-1001\",\n \"affiliate_name\": \"Acme Media\",\n \"is_active\": true,\n \"payout_type\": \"percentage\",\n \"flat_rate\": null,\n \"percentage_rate\": \"30.00\",\n \"tiered_rates\": null,\n \"custom_rules\": null,\n \"pay_on_offer_purchase\": true,\n \"pay_on_upsell_purchase\": false,\n \"excluded_products\": null,\n \"excluded_countries\": [\"CA\"],\n \"created_at\": \"2026-06-16T14:22:05.000000Z\",\n \"updated_at\": \"2026-06-16T14:22:05.000000Z\"\n },\n \"success\": true,\n \"message\": \"Affiliate assigned to campaign successfully\"\n}\nRemove an affiliate's assignment (and payout configuration) from a campaign.
\nDeletes the campaign-affiliate assignment linking the given affiliate to the campaign. The affiliate is referenced by its custom_id in the URL path. Both the campaign and the affiliate must belong to the authenticated team, and an active assignment must exist between them. The assignment is soft-deleted.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.affiliates.unassign
This endpoint takes no request body.
\nReturns 200 OK with a confirmation message:
Request
\nDELETE https://api.sparkcrm.io/v1/campaigns/123/affiliates/AFF-1001
Response 200 OK
{\n \"success\": true,\n \"message\": \"Affiliate unassigned from campaign successfully\"\n}\nRetrieve every auto responder configured within a single campaign.
\nReturns all auto responders attached to the specified campaign, ordered by creation date (newest first). Each auto responder defines which lifecycle events trigger an automated email, which email template and SMTP provider are used, an optional send delay, and any products that should be excluded from triggering it.
\nBearer Token from collection Spark CRM
\nRequired permission: api:campaigns.auto_responders.view
This endpoint accepts no query parameters. The full result set is returned (not paginated).
\nReturns success: true and a data array. Each element is an auto responder object:
GET https://api.sparkcrm.io/v1/campaigns/123/auto-responders
Returns the array of auto responders for campaign 123.
Attach a new automated email responder to a campaign.
\nCreates an auto responder that automatically sends a chosen email template when one or more of the configured lifecycle events occur for an order or subscription in this campaign. The new responder is generated with a server-side UUID and returned in full.
\nBearer Token from collection Spark CRM
\nRequired permission: api:campaigns.auto_responders.create
Returns 201 Created with success: true, a message, and a data object containing the created auto responder. See the List endpoint for the full field reference.
POST https://api.sparkcrm.io/v1/campaigns/123/auto-responders
Creates an order-confirmation responder using template 45 and SMTP provider 12.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","name":"Spark CRM","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","campaigns","123","auto-responders"],"host":["api","sparkcrm","io"],"query":[],"variable":[]}},"response":[{"id":"d1989f3f-0a3f-c625-3c78-7571ea6249da","name":"Create Campaign Auto Responder","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Order Confirmation Email\",\n \"email_template_id\": 45,\n \"smtp_provider_id\": 12,\n \"trigger_types\": [\n \"order_confirmation\"\n ],\n \"trigger_conditions\": {\n \"days_before_billing\": 3\n },\n \"delay_minutes\": 0,\n \"excluded_products\": [\n 88\n ],\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparkcrm.io/v1/campaigns/123/auto-responders","description":"# Create Campaign Auto Responder\n\n**Attach a new automated email responder to a campaign.**\n\nCreates an auto responder that automatically sends a chosen email template when one or more of the configured lifecycle events occur for an order or subscription in this campaign. The new responder is generated with a server-side UUID and returned in full.\n\n## Authorization\n\nBearer Token from collection Spark CRM\n\n**Required permission:** `api:campaigns.auto_responders.create`\n\n## Request Body\n\n| Request Field | Description |\n| --- | --- |\n| `name` | _**string (required)**_ — Display name for the auto responder. Max length 255. |\n| `email_template_id` | _**integer (required)**_ — ID of the email template to send. Must exist in `email_templates` and belong to the authenticated team. |\n| `smtp_provider_id` | _**integer (optional)**_ — ID of the SMTP provider used to deliver the email. Must exist in `smtp_providers` and belong to the authenticated team. Nullable; omit/`null` to use the default sender. |\n| `trigger_types` | _**array (required)**_ — Non-empty array of trigger event strings. At least one (`min:1`) required. Allowed values: `order_confirmation`, `tracking_issued`, `carrier_accepted`, `order_shipped`, `shipment_in_transit`, `shipment_out_for_delivery`, `shipment_delivered`, `order_refunded`, `order_canceled`, `order_voided`, `subscription_reminder`, `subscription_renewed`. |\n| `trigger_types[]` | _**string (required)**_ — Each element must be one of the allowed trigger enum values listed above. |\n| `trigger_conditions` | _**object (optional)**_ — Arbitrary condition map. Nullable. For `subscription_reminder` triggers, supply `days_before_billing` (integer; defaults to 3 when unset). |\n| `delay_minutes` | _**integer (optional)**_ — Minutes to wait after the trigger fires before sending. Nullable. Minimum 0. |\n| `excluded_products` | _**array (optional)**_ — Array of product IDs that should NOT cause this responder to fire. Nullable. |\n| `is_active` | _**boolean (optional)**_ — Whether the responder is enabled. Nullable boolean; defaults to inactive/unset when omitted. |\n\n## Response\n\nReturns `201 Created` with `success: true`, a `message`, and a `data` object containing the created auto responder. See the List endpoint for the full field reference.\n\n## Errors\n\n| Status | Meaning |\n| --- | --- |\n| 422 | Validation error. Returned with `errors` keyed by field (e.g. invalid `trigger_types`, `email_template_id` not found for team, empty `trigger_types`). |\n| 403 | Token lacks the `api:campaigns.auto_responders.create` (or legacy `api:create`) permission. |\n| 404 | Campaign not found for the authenticated team. |\n\n## Example\n\n`POST https://api.sparkcrm.io/v1/campaigns/123/auto-responders`\n\nCreates an order-confirmation responder using template 45 and SMTP provider 12."},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Auto responder created successfully\",\n \"data\": {\n \"id\": \"9b2f1c4e-7a3d-4f2b-8c1a-2e5d6f7a8b9c\",\n \"campaign_id\": \"123\",\n \"name\": \"Order Confirmation Email\",\n \"is_active\": true,\n \"trigger_types\": [\n \"order_confirmation\"\n ],\n \"trigger_conditions\": {\n \"days_before_billing\": 3\n },\n \"delay_minutes\": 0,\n \"email_template_id\": 45,\n \"smtp_provider_id\": 12,\n \"excluded_products\": [\n 88\n ],\n \"created_at\": \"2026-06-16T18:42:10.000000Z\",\n \"updated_at\": \"2026-06-16T18:42:10.000000Z\"\n }\n}"}],"_postman_id":"cc654050-0896-ac5e-345d-181000e0ce22"},{"name":"Update Campaign Auto Responder","id":"cd021336-4431-b460-e287-50598bbaf30f","request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Order Confirmation Email (v2)\",\n \"is_active\": false,\n \"trigger_types\": [\n \"order_confirmation\",\n \"order_shipped\"\n ],\n \"delay_minutes\": 15,\n \"excluded_products\": [\n 88,\n 102\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparkcrm.io/v1/campaigns/123/auto-responders/9b2f1c4e-7a3d-4f2b-8c1a-2e5d6f7a8b9c","description":"Modify an existing auto responder on a campaign.
\nUpdates one auto responder identified by its UUID (assignment_id). All fields are optional on update — send only the fields you wish to change. Any field that is supplied is fully re-validated using the same rules as creation.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.auto_responders.update
All fields use sometimes semantics — included fields are validated, omitted fields are left unchanged.
Returns 200 OK with success: true, a message, and the updated auto responder in data. See the List endpoint for the full field reference.
PATCH https://api.sparkcrm.io/v1/campaigns/123/auto-responders/9b2f1c4e-7a3d-4f2b-8c1a-2e5d6f7a8b9c
Disables the responder and adds the order_shipped trigger.
Remove an auto responder from a campaign.
\nSoft-deletes the auto responder identified by its UUID (assignment_id) within the given campaign. Once deleted it no longer fires on campaign lifecycle events.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.auto_responders.delete
This endpoint accepts no request body.
\nReturns 200 OK with a confirmation message.
DELETE https://api.sparkcrm.io/v1/campaigns/123/auto-responders/9b2f1c4e-7a3d-4f2b-8c1a-2e5d6f7a8b9c
Deletes the specified auto responder.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","name":"Spark CRM","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","campaigns","123","auto-responders","9b2f1c4e-7a3d-4f2b-8c1a-2e5d6f7a8b9c"],"host":["api","sparkcrm","io"],"query":[],"variable":[]}},"response":[{"id":"e920829d-b1f2-fa61-e539-b2837b30ec2f","name":"Delete Campaign Auto Responder","originalRequest":{"method":"DELETE","header":[],"url":"https://api.sparkcrm.io/v1/campaigns/123/auto-responders/9b2f1c4e-7a3d-4f2b-8c1a-2e5d6f7a8b9c","description":"# Delete Campaign Auto Responder\n\n**Remove an auto responder from a campaign.**\n\nSoft-deletes the auto responder identified by its UUID (`assignment_id`) within the given campaign. Once deleted it no longer fires on campaign lifecycle events.\n\n## Authorization\n\nBearer Token from collection Spark CRM\n\n**Required permission:** `api:campaigns.auto_responders.delete`\n\n## Request Object\n\n| Request Field | Description |\n| --- | --- |\n| `identifier` | _**string (required)**_ — Path parameter. The campaign's `internal_id`. Campaign must belong to the authenticated team. |\n| `assignment_id` | _**string (required)**_ — Path parameter. The auto responder UUID (the `id` returned by List/Create). |\n\nThis endpoint accepts no request body.\n\n## Response\n\nReturns `200 OK` with a confirmation message.\n\n| Field | Description |\n| --- | --- |\n| `success` | boolean — Always `true` on success. |\n| `message` | string — `Auto responder deleted successfully`. |\n\n## Errors\n\n| Status | Meaning |\n| --- | --- |\n| 403 | Token lacks the `api:campaigns.auto_responders.delete` (or legacy `api:delete`) permission. |\n| 404 | Campaign not found, or auto responder not found within the campaign. |\n\n## Example\n\n`DELETE https://api.sparkcrm.io/v1/campaigns/123/auto-responders/9b2f1c4e-7a3d-4f2b-8c1a-2e5d6f7a8b9c`\n\nDeletes the specified auto responder."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Auto responder deleted successfully\"\n}"}],"_postman_id":"a9240ca0-723c-c2bb-1cf1-5653fd3a8865"}],"id":"87bb317e-f6f9-d0e0-8d49-2db22a65eb4e","_postman_id":"87bb317e-f6f9-d0e0-8d49-2db22a65eb4e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","name":"Spark CRM","type":"collection"}}},{"name":"Search Campaign(s)","id":"616648a1-9455-4c37-b54e-b1f57fa220f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sparkcrm.io/v1/campaigns?is_active=1&per_page=10","description":"Retrieve information about campaigns that match the specified search criteria, or get a specific campaign by its identifier.
\nBearer Token from collection Spark CRM
\nGET /v1/campaigns\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/campaigns?identifier=123\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\n{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"internal_id\": \"123\",\n \"name\": \"Summer Sale Campaign\",\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"is_active\": true,\n \"allowed_countries\": [\"US\", \"CA\", \"GB\"],\n \"allowed_currencies\": [\"USD\", \"CAD\", \"GBP\"],\n \"restrict_by_ip_country\": false,\n \"allowed_card_brands\": [\"visa\", \"mastercard\", \"amex\"],\n \"allow_prepaid_cards\": true,\n \"allow_virtual_cards\": false,\n \"allow_international_cards\": true,\n \"minimum_amount\": \"1000\",\n \"maximum_amount\": \"50000\",\n \"max_customer_declines\": 3,\n \"max_orders_per_email\": 1,\n \"max_upsell_declines\": 2,\n \"fulfillment_delay\": 24,\n \"category\": {\n \"id\": 1,\n \"name\": \"E-commerce\"\n },\n \"gateway_id\": 1,\n \"payment_orchestrator_id\": null,\n \"created_at\": \"2024-01-15T10:30:00.000Z\",\n \"updated_at\": \"2024-01-20T14:45:00.000Z\",\n \"offers_count\": 3,\n \"upsells_count\": 2\n }\n}\n\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"internal_id\": \"123\",\n \"name\": \"Summer Sale Campaign\",\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"is_active\": true,\n \"allowed_countries\": [\"US\", \"CA\", \"GB\"],\n \"allowed_currencies\": [\"USD\", \"CAD\", \"GBP\"],\n \"restrict_by_ip_country\": false,\n \"allowed_card_brands\": [\"visa\", \"mastercard\", \"amex\"],\n \"allow_prepaid_cards\": true,\n \"allow_virtual_cards\": false,\n \"allow_international_cards\": true,\n \"minimum_amount\": \"1000\",\n \"maximum_amount\": \"50000\",\n \"max_customer_declines\": 3,\n \"max_orders_per_email\": null,\n \"max_upsell_declines\": null,\n \"fulfillment_delay\": 24,\n \"category\": {\n \"id\": 1,\n \"name\": \"E-commerce\"\n },\n \"gateway_id\": 1,\n \"payment_orchestrator_id\": null,\n \"created_at\": \"2024-01-15T10:30:00.000Z\",\n \"updated_at\": \"2024-01-20T14:45:00.000Z\",\n \"offers_count\": 3,\n \"upsells_count\": 2\n }\n ],\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 1\n }\n}\n\nPage number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"05130008-cb41-47b9-87dc-9835df34f68c","name":"Search Campaign(s)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparkcrm.io/v1/campaigns?is_active=1&per_page=10","protocol":"https","host":["api","sparkcrm","io"],"path":["v1","campaigns"],"query":[{"key":"is_active","value":"1"},{"key":"per_page","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.25.2"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.4.7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 18 Jun 2025 17:43:12 GMT"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"98"},{"key":"X-RateLimit-Reset","value":"32000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"smartewatch.com\",\n \"is_active\": true,\n \"allowed_countries\": [\n \"US\"\n ],\n \"allowed_currencies\": [\n \"USD\"\n ],\n \"restrict_by_ip_country\": false,\n \"allowed_card_brands\": [\n \"visa\",\n \"mastercard\",\n \"discover\",\n \"amex\"\n ],\n \"allow_prepaid_cards\": true,\n \"allow_virtual_cards\": true,\n \"allow_international_cards\": 1,\n \"minimum_amount\": null,\n \"maximum_amount\": null,\n \"max_customer_declines\": 3,\n \"max_orders_per_email\": null,\n \"max_upsell_declines\": null,\n \"fulfillment_delay\": 0,\n \"category\": {\n \"name\": \"Watches\"\n },\n \"offers_count\": 2,\n \"upsells_count\": 1,\n \"created_at\": \"2025-03-25T20:47:49.000000Z\",\n \"updated_at\": \"2025-07-30T23:56:55.000000Z\"\n }\n ],\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 1\n }\n}"}],"_postman_id":"616648a1-9455-4c37-b54e-b1f57fa220f2"},{"name":"Create Campaign","id":"04ee7289-0528-8696-11b5-31ae0bc14d29","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Summer Skincare Funnel\",\n \"is_active\": true,\n \"allowed_countries\": [\"US\", \"CA\"],\n \"allowed_currencies\": [\"USD\"],\n \"allowed_card_brands\": [\"visa\", \"mastercard\", \"amex\", \"discover\"],\n \"allow_prepaid_cards\": true,\n \"allow_virtual_cards\": true,\n \"allow_international_cards\": true,\n \"restrict_by_ip_country\": false,\n \"minimum_amount\": 1.00,\n \"maximum_amount\": 5000.00,\n \"fulfillment_delay\": 0,\n \"max_customer_declines\": 3,\n \"max_orders_per_email\": 0,\n \"max_upsell_declines\": 3,\n \"max_reprocess_attempts_per_decline\": 2,\n \"gateway_id\": 1,\n \"payment_orchestrator_id\": 1,\n \"decline_salvage_profile_id\": 4,\n \"decline_salvage_disabled\": false,\n \"campaign_category_id\": 2,\n \"tax_enabled\": true,\n \"bypass_email_validation\": false,\n \"bypass_phone_validation\": false,\n \"bypass_address_validation\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparkcrm.io/v1/campaigns","description":"Create a New Campaign
\nCreate a new campaign for the authenticated account. Returns the detailed campaign object on success. Foreign-key fields (gateway_id, payment_orchestrator_id) are supplied as the team's internal ids, not database ids. When omitted, several fields fall back to system defaults (e.g. allowed_countries → [\"US\"], allowed_currencies → [\"USD\"], allowed_card_brands → [\"visa\", \"mastercard\", \"amex\", \"discover\"], is_active → true, max_customer_declines → 3).
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.create
201 Created — returns the full detailed campaign object identical to the Get Campaign response, plus:
{\n \"success\": true,\n \"message\": \"Campaign created successfully\"\n}\nRetrieve a Single Campaign
\nRetrieve a single campaign by its identifier (the team's internal campaign id). Database ids are never exposed. The response is the detailed campaign object, including the salvage, tax, and validation-bypass settings.
\nGET https://api.sparkcrm.io/v1/campaigns/1\nBearer Token from collection Spark CRM
\nRequired permission: api:campaigns.view
Partially Update a Campaign
\nUpdate mutable fields on a campaign. All fields are optional; only validated fields that are present in the request body will be saved. The identifier in the URL is the team's internal campaign id. Foreign-key fields (gateway_id, payment_orchestrator_id) are supplied as the team's internal ids and must belong to the authenticated team.
Bearer Token from collection Spark CRM
\nRequired permission: api:campaigns.update
All fields are optional. Only the fields included will be updated.
\n200 OK — returns the updated detailed campaign object identical to the Get Campaign response, plus:
{\n \"success\": true,\n \"message\": \"Campaign updated successfully\"\n}\nRetrieve a specific alternative payment method by its ID.
\nBearer Token from collection Spark CRM
\nGET /v1/alternative-payments/2\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\n{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"name\": \"Zelle Payments\",\n \"payment_type\": \"zelle\",\n \"payment_type_label\": \"Zelle\",\n \"status\": \"active\",\n \"supports_refunds\": false,\n \"supports_voids\": false,\n \"supports_upsells\": false,\n \"test_mode\": false,\n \"requires_redirect\": false,\n \"created_at\": \"2026-02-12T11:00:00.000000Z\",\n \"updated_at\": \"2026-02-12T11:00:00.000000Z\"\n }\n}\n\nRetrieve a paginated list of alternative payment methods configured for your account. Use the id field from the response as the payment[external_payment_id] when creating orders.
Bearer Token from collection Spark CRM
\nGET /v1/alternative-payments\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/alternative-payments?payment_type=paypal_wallet\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/alternative-payments?status=active\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/alternative-payments?search=zelle\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\nGET /v1/alternative-payments?status=active&payment_type=external&per_page=10\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"PayPal Business\",\n \"payment_type\": \"paypal_wallet\",\n \"payment_type_label\": \"PayPal Wallet\",\n \"status\": \"active\",\n \"supports_refunds\": true,\n \"supports_voids\": true,\n \"supports_upsells\": true,\n \"test_mode\": false,\n \"requires_redirect\": true,\n \"created_at\": \"2026-02-12T10:00:00.000000Z\",\n \"updated_at\": \"2026-02-12T13:33:00.000000Z\"\n },\n {\n \"id\": 2,\n \"name\": \"Zelle Payments\",\n \"payment_type\": \"zelle\",\n \"payment_type_label\": \"Zelle\",\n \"status\": \"active\",\n \"supports_refunds\": false,\n \"supports_voids\": false,\n \"supports_upsells\": false,\n \"test_mode\": false,\n \"requires_redirect\": false,\n \"created_at\": \"2026-02-12T11:00:00.000000Z\",\n \"updated_at\": \"2026-02-12T11:00:00.000000Z\"\n }\n ],\n \"pagination\": {\n \"total\": 2,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 2\n }\n}\n\nPage number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"4ce263d9-58fe-4078-b6be-e47d8d048066","name":"List Alternative Payments","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparkcrm.io/v1/alternative-payments?payment_type=paypal_wallet&status=active&search=paypal&per_page=10","protocol":"https","host":["api","sparkcrm","io"],"path":["v1","alternative-payments"],"query":[{"key":"payment_type","value":"paypal_wallet"},{"key":"status","value":"active"},{"key":"search","value":"paypal"},{"key":"per_page","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.25.2"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.4.7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 18 Jun 2025 17:43:12 GMT"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"98"},{"key":"X-RateLimit-Reset","value":"32000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"PayPal Business\",\n \"payment_type\": \"paypal_wallet\",\n \"payment_type_label\": \"PayPal Wallet\",\n \"status\": \"active\",\n \"supports_refunds\": true,\n \"supports_voids\": true,\n \"supports_upsells\": true,\n \"test_mode\": false,\n \"requires_redirect\": true,\n \"created_at\": \"2026-02-12T10:00:00.000000Z\",\n \"updated_at\": \"2026-02-12T13:33:00.000000Z\"\n },\n {\n \"id\": 2,\n \"name\": \"Zelle Payments\",\n \"payment_type\": \"zelle\",\n \"payment_type_label\": \"Zelle\",\n \"status\": \"active\",\n \"supports_refunds\": false,\n \"supports_voids\": false,\n \"supports_upsells\": false,\n \"test_mode\": false,\n \"requires_redirect\": false,\n \"created_at\": \"2026-02-12T11:00:00.000000Z\",\n \"updated_at\": \"2026-02-12T11:00:00.000000Z\"\n }\n ],\n \"pagination\": {\n \"total\": 2,\n \"per_page\": 10,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 2\n }\n}\n\n"}],"_postman_id":"aa098d7a-1059-4cb9-822c-d40f268b3fb8"}],"id":"7d9f025b-bc73-4abd-b6ac-840dc8cda06b","_postman_id":"7d9f025b-bc73-4abd-b6ac-840dc8cda06b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","name":"Spark CRM","type":"collection"}}},{"name":"Coupons","item":[{"name":"Search Coupons","id":"06606fab-1b95-4031-bbeb-b391dcdf02b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sparkcrm.io/v1/coupons","description":"Retrieve a paginated list of coupons with optional filtering and search capabilities.
\nBearer Token from collection Spark CRM
\nPage number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"2677291d-2b10-4bb8-903f-fa3f2fa3834b","name":"Search Coupons Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparkcrm.io/v1/coupons","protocol":"https","host":["api","sparkcrm","io"],"path":["v1","coupons"],"query":[{"key":" code","value":" SUMMER2025","type":"text","disabled":true},{"key":" is_active","value":" true","type":"text","disabled":true},{"key":" type","value":" percentage","type":"text","disabled":true},{"key":" search","value":" summer","type":"text","disabled":true},{"key":" per_page","value":" 15","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.25.2"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.4.11"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 21 Aug 2025 02:38:24 GMT"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"60000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"code\": \"TEST10\",\n \"name\": \"TEST10\",\n \"description\": \"\",\n \"type\": \"fixed_amount\",\n \"is_active\": true,\n \"discount_amount\": \"10.00\",\n \"minimum_purchase\": null,\n \"maximum_discount\": null,\n \"usage_limit_per_coupon\": null,\n \"usage_limit_per_customer\": null,\n \"total_uses\": 2,\n \"starts_at\": null,\n \"expires_at\": null,\n \"individual_use_only\": false,\n \"allowed_products\": [],\n \"excluded_products\": [],\n \"allowed_categories\": [],\n \"excluded_categories\": [],\n \"allowed_countries\": [],\n \"excluded_countries\": [],\n \"allowed_emails\": [],\n \"first_time_customer_only\": false,\n \"is_valid\": true,\n \"is_expired\": false,\n \"has_reached_usage_limit\": false,\n \"provider\": null,\n \"created_at\": \"2025-08-20T21:30:52.000000Z\",\n \"updated_at\": \"2025-08-20T21:39:54.000000Z\"\n }\n ],\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 1\n }\n}"}],"_postman_id":"06606fab-1b95-4031-bbeb-b391dcdf02b4"},{"name":"Get Coupon","id":"f810153e-242a-418d-a093-d8ca9ac4d906","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sparkcrm.io/v1/coupons/{{code}}","description":"Retrieve detailed information about a specific coupon by its code.
\nBearer Token from collection Spark CRM
\nCreate a new coupon with specified discount rules and restrictions.
\nBearer Token from collection Spark CRM
\nValidate a coupon for checkout and calculate the discount amount based on the provided context.
\nBearer Token from collection Spark CRM
\nUpdate an existing coupon's properties and restrictions.
\nBearer Token from collection Spark CRM
\nSoft delete a coupon from the system.
\nBearer Token from collection Spark CRM
\nRetrieve notes for a specific customer that match the specified search criteria.
\nBearer Token from collection Spark CRM
\nPage number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"f24a145a-fe33-431d-8fed-b09aa08aeb6a","name":"Get Notes","originalRequest":{"method":"GET","header":[],"url":"https://sparkcrm.test/v1/customers/CUST-250815-00142/notes"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.25.2"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.4.12"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 17 Sep 2025 03:19:20 GMT"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"98"},{"key":"X-RateLimit-Reset","value":"56000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 584,\n \"title\": null,\n \"content\": \"Eos dolorem eos omnis optio. Molestiae assumenda itaque ea voluptate in. Optio dicta asperiores porro earum repudiandae velit aut.\",\n \"type\": \"support\",\n \"created_by\": \"Ut magni autem sunt fuga iure.\",\n \"created_at\": \"2025-02-04T02:25:14.000000Z\",\n \"updated_at\": \"2025-08-15T01:57:33.000000Z\"\n },\n {\n \"id\": 583,\n \"title\": \"Soluta vel et ut.\",\n \"content\": \"Nesciunt est voluptatem non reiciendis sed. Non a est tempore commodi.\",\n \"type\": \"fraud\",\n \"created_by\": \"Neque doloremque totam quasi recusandae natus numquam.\",\n \"created_at\": \"2024-10-08T05:55:00.000000Z\",\n \"updated_at\": \"2025-08-15T01:57:33.000000Z\"\n }\n ],\n \"customer\": {\n \"customer_number\": \"CUST-250815-00142\",\n \"email\": \"waelchi.emerald@example.net\",\n \"name\": \"Alec Schmeler\"\n },\n \"pagination\": {\n \"total\": 2,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 2\n }\n}"}],"_postman_id":"569d87b4-40b3-4403-8906-21174af5e217"},{"name":"Get Note","id":"9b6d8382-75aa-49e5-aa91-f60f6a11ca87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sparkcrm.io/v1/customers/{customer_number}/notes/{noteId}","description":"Retrieve a specific note for a customer by note ID.
\nBearer Token from collection Spark CRM
\nNo request body parameters. The customer number and note ID are provided in the URL path.
\nCreate a new note for a specific customer.
\nBearer Token from collection Spark CRM
\nUpdate an existing note for a specific customer.
\nBearer Token from collection Spark CRM
\nNote: At least one field must be provided to update the note. All fields use \"sometimes\" validation, meaning they're only validated if present in the request.
\nDelete a specific note for a customer by note ID.
\nBearer Token from collection Spark CRM
\nNo request body parameters. The customer number and note ID are provided in the URL path.
\nAdd tracking information to a fulfillment. When tracking is added, Spark automatically updates the fulfillment status to shipped, sets the shipped timestamp, and triggers any webhooks, auto-responders, or other system functionality tied to tracking being issued.
POST https://api.sparkcrm.io/v1/fulfillments/FUL-260310-00001/add_tracking\nBearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.add_tracking
Returns the updated fulfillment in the same shape as GET /v1/fulfillments/{fulfillmentNumber}. The status will be shipped and shipped_at populated.
Cancel a fulfillment. Restores product stock and attempts to cancel with the fulfillment provider if an external ID is set.
\nAllowed when: the current status is pending, processing, or tracking_issued. Returns 422 otherwise.
POST https://api.sparkcrm.io/v1/fulfillments/FUL-260310-00001/cancel\nBearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.cancel
Returns the updated fulfillment in the same shape as GET /v1/fulfillments/{fulfillmentNumber}. The status will be canceled.
Create a new replacement fulfillment from an existing one. Works regardless of the original fulfillment's current status. If the original was shipped or delivered, it is automatically marked as returned.
The response returns the new fulfillment object. The new fulfillment's metadata.is_reship is true.
POST https://api.sparkcrm.io/v1/fulfillments/FUL-260310-00001/reship\nBearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.reship
Returns the new reship fulfillment in the same shape as GET /v1/fulfillments/{fulfillmentNumber}. Its metadata.is_reship is true and metadata.reship_count is incremented.
Update the fulfillment status to shipped and record the shipped_at timestamp. Triggers any webhooks, auto-responders, or system functionality configured for the shipped event.
POST https://api.sparkcrm.io/v1/fulfillments/FUL-260310-00001/mark_shipped\nBearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.mark_shipped
No request body required.
\nReturns the updated fulfillment in the same shape as GET /v1/fulfillments/{fulfillmentNumber}. The status will be shipped and shipped_at populated.
Update the fulfillment status to delivered and record the delivered_at timestamp. Triggers any webhooks, auto-responders, or system functionality configured for the delivered event.
POST https://api.sparkcrm.io/v1/fulfillments/FUL-260310-00001/mark_delivered\nBearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.mark_delivered
No request body required.
\nReturns the updated fulfillment in the same shape as GET /v1/fulfillments/{fulfillmentNumber}. The status will be delivered and delivered_at populated.
List & Search for Fulfillments
\nRetrieve fulfillments that match the specified search criteria with filtering and pagination support.
\nGET https://api.sparkcrm.io/v1/fulfillments?status=pending\nReturns a paginated list of all fulfillments currently in pending status for the authenticated team. Combine with per_page, sort_by, or any other filter to narrow the results further.
Bearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.view
Page number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"a2109539-1b6a-4b20-8898-77a51b225a64","name":"Get Fulfillments","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sparkcrm.test/v1/fulfillments?per_page=1","protocol":"https","host":["sparkcrm","test"],"path":["v1","fulfillments"],"query":[{"key":"per_page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.25.2"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.4.12"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 17 Sep 2025 03:04:02 GMT"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"60000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 543,\n \"fulfillment_number\": \"FUL-250815-00543\",\n \"shipping_group_number\": \"ccfafc41-daaf-3496-8ec4-db3804936b3f\",\n \"status\": \"pending\",\n \"fulfillment_type\": \"manual\",\n \"items\": [\n {\n \"quantity\": 1,\n \"product_id\": 1,\n \"unit_price\": \"299.99\",\n \"product_sku\": \"SKU-4991om\",\n \"total_price\": 299.99,\n \"product_name\": \"Smart Watch Pro\",\n \"base_quantity\": 1,\n \"order_quantity\": 1,\n \"product_options\": null\n },\n {\n \"quantity\": 1,\n \"product_id\": 8,\n \"unit_price\": \"45.99\",\n \"product_sku\": \"SKU-7191sf\",\n \"total_price\": 45.99,\n \"product_name\": \"Smart Water Bottle\",\n \"base_quantity\": 1,\n \"order_quantity\": 1,\n \"product_options\": null\n }\n ],\n \"shipping_carrier\": null,\n \"shipping_service\": null,\n \"tracking_number\": null,\n \"tracking_urls\": null,\n \"rma_number\": null,\n \"created_at\": \"2025-09-14T17:13:19.000000Z\",\n \"updated_at\": \"2025-09-17T17:13:19.000000Z\",\n \"order\": {\n \"id\": 659,\n \"order_number\": \"ORD-250815-00318\"\n },\n \"customer\": {\n \"customer_number\": \"CUST-250815-00157\",\n \"email\": \"lwest@example.net\",\n \"name\": \"Bonita Botsford\"\n }\n }\n ],\n \"pagination\": {\n \"total\": 1148,\n \"per_page\": 1,\n \"current_page\": 1,\n \"last_page\": 1148,\n \"from\": 1,\n \"to\": 1\n }\n}"}],"_postman_id":"cc8fda64-658d-4f94-9b20-f245f3b656b7"},{"name":"Get Fulfillment","id":"6e4ce771-17e9-4043-985e-7efd9433f001","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sparkcrm.io/v1/fulfillments/{fulfillmentNumber}","description":"Retrieve detailed information for a specific fulfillment by fulfillment number.
\nBearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.view
No request body parameters. The fulfillment number is provided in the URL path.
\nCreate one or more fulfillments for an existing order. Returns an array of created fulfillments — one per fulfillment provider when products span multiple providers.
\nPOST https://api.sparkcrm.io/v1/fulfillments\nBearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.create
Returns an array of fulfillment objects in the same shape as GET /v1/fulfillments/{fulfillmentNumber}. One fulfillment per provider.
Update a fulfillment's tracking info, shipping address, or status. All fields are optional (PATCH semantics).
\nImportant: Providing a tracking_number automatically sets the status to shipped and dispatches tracking events — clients should not separately update the status when adding tracking.
PATCH https://api.sparkcrm.io/v1/fulfillments/FUL-260310-00001\nBearer Token from collection Spark CRM
\nRequired permission: api:fulfillments.update
Returns the updated fulfillment in the same shape as GET /v1/fulfillments/{fulfillmentNumber}.
Retrieve notes for a specific order that match the specified search criteria.
\nBearer Token from collection Spark CRM
\nPage number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"ecbbab19-a277-4b5a-9fed-f459d00c3291","name":"Get Order Notes","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://sparkcrm.test/v1/orders/ORD-250815-00297/notes"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.25.2"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.4.12"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 17 Sep 2025 03:06:47 GMT"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"99"},{"key":"X-RateLimit-Reset","value":"59000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1243,\n \"title\": \"Iusto aperiam hic.\",\n \"content\": \"Voluptatem quo dolores error autem. Consequatur explicabo velit quo aut veritatis modi eius. Odit harum maxime beatae velit officiis sed architecto.\",\n \"type\": \"shipping\",\n \"created_by\": \"Tempore deserunt blanditiis velit amet.\",\n \"created_at\": \"2024-10-12T15:06:27.000000Z\",\n \"updated_at\": \"2025-08-15T01:57:50.000000Z\"\n }\n ],\n \"order\": {\n \"order_number\": \"ORD-250815-00297\",\n \"status\": \"completed\"\n },\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 1\n }\n}"}],"_postman_id":"3e54f66a-b2f9-41f1-a8f9-85e575aa9641"},{"name":"Create Order Note","id":"8f92fa01-bca8-4a55-9307-aecd97a64c5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.sparkcrm.io/v1/orders/{orderNumber}/notes","description":"Create a new note for a specific order.
\nBearer Token from collection Spark CRM
\nRetrieve a specific note for an order by note ID.
\nBearer Token from collection Spark CRM
\nNo request body parameters. The order number and note ID are provided in the URL path.
\nUpdate an existing note for a specific order.
\nBearer Token from collection Spark CRM
\nNote: At least one field must be provided to update the note. All fields use \"sometimes\" validation, meaning they're only validated if present in the request.
\nDelete a specific note for an order by note ID.
\nBearer Token from collection Spark CRM
\nNo request body parameters. The order number and note ID are provided in the URL path.
\nRetrieve all products (offers and upsells combined) for a specific campaign. Products are returned sorted by position and can be filtered by type and active status.
\nBearer Token from collection Spark CRM
\nGET /v1/campaigns/123/products\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\nGET /v1/campaigns/123/products?is_active=true\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\nGET /v1/campaigns/123/products?product_type=offer\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\nGET /v1/campaigns/123/products?product_type=upsell\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\nGET /v1/campaigns/123/products?product_type=offer&is_active=true&per_page=10\nAuthorization: Bearer YOUR_API_KEY_HERE\nContent-Type: application/json\nAccept: application/json\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"internal_id\": \"offer_001\",\n \"name\": \"Premium Package\",\n \"product_type\": \"offer\",\n \"is_active\": true,\n \"position\": 1,\n \"price\": \"2999\",\n \"shipping_price\": \"599\",\n \"tax_rate\": \"0.08\",\n \"is_tax_included\": false,\n \"dynamic_descriptor\": \"PREMIUM PKG\",\n \"sale_type\": \"one_time\",\n \"subscription_config\": null,\n \"allow_duplicates\": null,\n \"requires_shipping_on_trial\": null,\n \"billing_interval\": null,\n \"billing_cycles\": null,\n \"billing_schedule\": null,\n \"use_offer_gateway\": null,\n \"gateway_id\": null,\n \"payment_orchestrator_id\": null,\n \"product\": {\n \"id\": 1,\n \"name\": \"Premium Package\",\n \"sku\": \"PREM-001\",\n \"description\": \"Our premium package with all features included\",\n \"weight\": \"2.5\",\n \"dimensions\": {\n \"length\": \"10\",\n \"width\": \"8\",\n \"height\": \"6\"\n },\n \"requires_shipping\": true\n },\n \"created_at\": \"2024-01-15T10:30:00.000Z\",\n \"updated_at\": \"2024-01-20T14:45:00.000Z\"\n },\n {\n \"id\": 2,\n \"internal_id\": \"upsell_001\",\n \"name\": \"Extended Warranty\",\n \"product_type\": \"upsell\",\n \"is_active\": true,\n \"position\": 2,\n \"price\": \"999\",\n \"shipping_price\": \"0\",\n \"tax_rate\": \"0.08\",\n \"is_tax_included\": false,\n \"dynamic_descriptor\": \"WARRANTY\",\n \"sale_type\": \"subscription\",\n \"subscription_config\": {\n \"interval\": \"monthly\",\n \"cycles\": 12\n },\n \"allow_duplicates\": false,\n \"requires_shipping_on_trial\": false,\n \"billing_interval\": \"monthly\",\n \"billing_cycles\": 12,\n \"billing_schedule\": {\n \"start_date\": \"immediate\",\n \"trial_days\": 0\n },\n \"use_offer_gateway\": true,\n \"gateway_id\": null,\n \"payment_orchestrator_id\": null,\n \"product\": {\n \"id\": 2,\n \"name\": \"Extended Warranty\",\n \"sku\": \"WARR-001\",\n \"description\": \"12-month extended warranty coverage\",\n \"weight\": \"0\",\n \"dimensions\": null,\n \"requires_shipping\": false\n },\n \"created_at\": \"2024-01-15T11:00:00.000Z\",\n \"updated_at\": \"2024-01-20T15:00:00.000Z\"\n }\n ],\n \"campaign\": {\n \"internal_id\": \"123\",\n \"name\": \"Summer Sale Campaign\",\n \"uuid\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n \"pagination\": {\n \"total\": 2,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 2\n }\n}\nRetrieve a paginated list of products for the authenticated account.
\nReturns products belonging to the authenticated team, ordered by created_at descending (newest first). Supports filtering by active status and product type, plus free-text search across product name, SKU, and internal id.
Bearer Token from collection Spark CRM
\nRequired permission: api:products.view_any
Returns success: true, a data[] array of product summary objects, and a pagination object. List items use the summary (non-detailed) shape.
Request
\nGET /v1/products?per_page=2&product_type=physical&is_active=true
Response 200 OK — see the example response.
Optional free-text search. Matches against product name (LIKE), sku (LIKE), and internal_id (exact, when the search term is all digits). Max 255 characters.
\n","type":"text/plain"},"key":"search","value":"tshirt"},{"description":{"content":"Optional boolean filter. true returns only active products, false only inactive. Omit to return both. Accepts true/false/1/0.
\n","type":"text/plain"},"key":"is_active","value":"true"},{"description":{"content":"Optional. Filter by product type. One of: physical, digital, subscription.
\n","type":"text/plain"},"key":"product_type","value":"physical"},{"description":{"content":"Optional. Results per page. Integer between 1 and 100. Defaults to 15.
\n","type":"text/plain"},"key":"per_page","value":"15"},{"description":{"content":"Optional. Page number to retrieve. Integer, min 1. Defaults to 1.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"2f592f28-8011-7d9b-58cf-c6364d5e67c3","name":"List Products","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparkcrm.io/v1/products?per_page=15&page=1&search=tshirt&is_active=true&product_type=physical","protocol":"https","host":["api","sparkcrm","io"],"path":["v1","products"],"query":[{"key":"search","description":"Optional free-text search. Matches against product name (LIKE), sku (LIKE), and internal_id (exact, when the search term is all digits). Max 255 characters.","value":"tshirt"},{"key":"is_active","description":"Optional boolean filter. true returns only active products, false only inactive. Omit to return both. Accepts true/false/1/0.","value":"true"},{"key":"product_type","description":"Optional. Filter by product type. One of: physical, digital, subscription.","value":"physical"},{"key":"per_page","description":"Optional. Results per page. Integer between 1 and 100. Defaults to 15.","value":"15"},{"key":"page","description":"Optional. Page number to retrieve. Integer, min 1. Defaults to 1.","value":"1"}]},"description":"# List Products\n\n**Retrieve a paginated list of products for the authenticated account.**\n\nReturns products belonging to the authenticated team, ordered by `created_at` descending (newest first). Supports filtering by active status and product type, plus free-text search across product name, SKU, and internal id.\n\n## Authorization\n\nBearer Token from collection Spark CRM\n\n**Required permission:** `api:products.view_any`\n\n## Request Object\n\n| Request Field | Description |\n| --- | --- |\n| `search` | _**string (optional)**_ Free-text search. Matches `name` (LIKE), `sku` (LIKE), and `internal_id` (exact match, only when the term is all digits). Max 255 characters. |\n| `is_active` | _**boolean (optional)**_ Filter by active state. `true` returns active products, `false` returns inactive. Omit to return both. |\n| `product_type` | _**string (optional)**_ Filter by product type. One of `physical`, `digital`, `subscription`. |\n| `per_page` | _**integer (optional)**_ Number of results per page. Min `1`, max `100`. Defaults to `15`. |\n| `page` | _**integer (optional)**_ Page number to retrieve. Min `1`. Defaults to `1`. |\n\n## Response Object\n\nReturns `success: true`, a `data[]` array of product summary objects, and a `pagination` object. List items use the summary (non-detailed) shape.\n\n| Field | Description |\n| --- | --- |\n| `data[].id` | _integer_ The product's account-scoped `internal_id`. Use this value as `{product_id}` in detail/update routes. |\n| `data[].name` | _string_ Product name. |\n| `data[].slug` | _string_ URL slug (auto-generated from name on creation when omitted). |\n| `data[].sku` | _string \\| null_ Stock keeping unit. |\n| `data[].barcode` | _string \\| null_ Barcode value. |\n| `data[].product_type` | _string \\| null_ One of `physical`, `digital`, `subscription`. |\n| `data[].fulfillment_type` | _string \\| null_ One of `physical`, `digital`, `email`, `manual`. |\n| `data[].price` | _string_ Selling price, formatted to 2 decimals. |\n| `data[].cost` | _string \\| null_ Unit cost, 2 decimals. |\n| `data[].estimated_shipping_cost` | _string \\| null_ Estimated shipping cost, 2 decimals. |\n| `data[].description` | _string \\| null_ Full product description. |\n| `data[].short_description` | _string \\| null_ Short description. |\n| `data[].requires_shipping` | _boolean_ Whether the product requires physical shipping. |\n| `data[].is_active` | _boolean_ Whether the product is active. |\n| `data[].is_taxable` | _boolean_ Whether tax applies to the product. |\n| `data[].track_inventory` | _boolean_ Whether inventory is tracked for the product. |\n| `data[].stock` | _integer \\| null_ Current stock level. |\n| `data[].quantity` | _integer \\| null_ Quantity value. |\n| `data[].low_stock_threshold` | _integer \\| null_ Stock level at which the product is considered low stock. |\n| `data[].created_at` | _string (ISO 8601)_ Creation timestamp. |\n| `data[].updated_at` | _string (ISO 8601)_ Last update timestamp. |\n| `pagination.total` | _integer_ Total number of matching products. |\n| `pagination.per_page` | _integer_ Results per page. |\n| `pagination.current_page` | _integer_ Current page number. |\n| `pagination.last_page` | _integer_ Last available page. |\n| `pagination.from` | _integer \\| null_ Index of the first item on the page. |\n| `pagination.to` | _integer \\| null_ Index of the last item on the page. |\n\n## Errors\n\n| Status | Meaning |\n| --- | --- |\n| `403` | Token lacks the necessary permissions (`api:products.view_any`). |\n| `422` | Validation error (e.g. invalid `product_type`, `per_page` out of range, non-boolean `is_active`). |\n\n## Example\n\n**Request**\n\n`GET /v1/products?per_page=2&product_type=physical&is_active=true`\n\n**Response** `200 OK` — see the example response."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1042,\n \"name\": \"Classic Cotton T-Shirt\",\n \"slug\": \"classic-cotton-t-shirt\",\n \"sku\": \"TSHIRT-CLS-001\",\n \"barcode\": \"0123456789012\",\n \"product_type\": \"physical\",\n \"fulfillment_type\": \"physical\",\n \"price\": \"29.99\",\n \"cost\": \"8.50\",\n \"estimated_shipping_cost\": \"4.95\",\n \"description\": \"A soft, durable 100% cotton t-shirt available in multiple colors.\",\n \"short_description\": \"100% cotton crew-neck tee.\",\n \"requires_shipping\": true,\n \"is_active\": true,\n \"is_taxable\": true,\n \"track_inventory\": true,\n \"stock\": 250,\n \"quantity\": 1,\n \"low_stock_threshold\": 25,\n \"created_at\": \"2026-06-10T14:22:05.000000Z\",\n \"updated_at\": \"2026-06-15T09:01:44.000000Z\"\n },\n {\n \"id\": 1041,\n \"name\": \"Premium Hoodie\",\n \"slug\": \"premium-hoodie\",\n \"sku\": \"HOODIE-PRM-002\",\n \"barcode\": null,\n \"product_type\": \"physical\",\n \"fulfillment_type\": \"physical\",\n \"price\": \"59.00\",\n \"cost\": \"18.00\",\n \"estimated_shipping_cost\": \"6.50\",\n \"description\": null,\n \"short_description\": \"Fleece-lined pullover hoodie.\",\n \"requires_shipping\": true,\n \"is_active\": true,\n \"is_taxable\": true,\n \"track_inventory\": true,\n \"stock\": 80,\n \"quantity\": 1,\n \"low_stock_threshold\": 10,\n \"created_at\": \"2026-06-09T11:10:33.000000Z\",\n \"updated_at\": \"2026-06-09T11:10:33.000000Z\"\n }\n ],\n \"pagination\": {\n \"total\": 37,\n \"per_page\": 2,\n \"current_page\": 1,\n \"last_page\": 19,\n \"from\": 1,\n \"to\": 2\n }\n}"}],"_postman_id":"36782395-4126-1344-2421-3cc8df99d36f"},{"name":"Create Product","id":"4747a804-e1a8-47bf-9e35-18e6ad312824","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Classic Cotton T-Shirt\",\n \"price\": 29.99,\n \"product_type\": \"physical\",\n \"fulfillment_type\": \"physical\",\n \"category_id\": 7,\n \"fulfillment_provider_id\": 3,\n \"description\": \"A soft, durable 100% cotton t-shirt available in multiple colors.\",\n \"short_description\": \"100% cotton crew-neck tee.\",\n \"sku\": \"TSHIRT-CLS-001\",\n \"barcode\": \"0123456789012\",\n \"cost\": 8.50,\n \"estimated_shipping_cost\": 4.95,\n \"track_inventory\": true,\n \"stock\": 250,\n \"quantity\": 1,\n \"low_stock_threshold\": 25,\n \"weight\": 0.30,\n \"length\": 25.00,\n \"width\": 20.00,\n \"height\": 2.00,\n \"weight_unit\": \"kg\",\n \"dimension_unit\": \"cm\",\n \"is_taxable\": true,\n \"tax_class\": \"standard\",\n \"tax_code\": \"PC040000\",\n \"requires_shipping\": true,\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparkcrm.io/v1/products","description":"Create a new product for the authenticated account.
\nCreates a product owned by the authenticated team. internal_id and slug are generated automatically (the slug derives from name when omitted). On success the full (detailed) product object is returned with HTTP 201.
Bearer Token from collection Spark CRM
\nRequired permission: api:products.create
Returns success: true, a message, and the created product under data using the detailed shape (includes dimensions, units, tax fields, product_image, and the loaded category). See the example response.
Request POST /v1/products with the JSON body shown in the request body tab.
Response 201 Created — see the example response.
Retrieve a single product by its internal id.
\nReturns the full (detailed) product object for the given internal_id, scoped to the authenticated team. The category relationship is eager-loaded.
Bearer Token from collection Spark CRM
\nRequired permission: api:products.view
Returns success: true and the product under data using the detailed shape.
Request GET /v1/products/1042
Response 200 OK — see the example response.
Partially update a product.
\nUpdates an existing product identified by its internal_id, scoped to the authenticated team. This is a partial update: every field is optional and only the fields you send are validated and saved. On success the full (detailed) product object is returned.
Bearer Token from collection Spark CRM
\nRequired permission: api:products.update
All fields are optional. When a field is present it must pass the rule shown below (the name and price fields are required-if-present, i.e. they may not be sent as empty/null).
Returns success: true, a message, and the updated product under data using the detailed shape (with the loaded category). See the example response.
Request PATCH /v1/products/1042 with a partial JSON body.
Response 200 OK — see the example response.
Retrieve notes for a specific transaction that match the specified search criteria.
\nBearer Token from collection Spark CRM
\nPage number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"5337d93d-7669-41ea-81e3-91ede253ee27","name":"Get Transaction Notes","originalRequest":{"method":"GET","header":[],"url":"https://sparkcrm.test/v1/transactions/TXN-250815-000538/notes"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.25.2"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.4.12"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 17 Sep 2025 03:16:41 GMT"},{"key":"X-RateLimit-Limit","value":"100"},{"key":"X-RateLimit-Remaining","value":"98"},{"key":"X-RateLimit-Reset","value":"48000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"transaction note\",\n \"content\": \"this is a new transaction note for shipping\",\n \"type\": \"shipping\",\n \"created_by\": \"2\",\n \"created_at\": \"2025-09-17T03:16:30.000000Z\",\n \"updated_at\": \"2025-09-17T03:16:30.000000Z\"\n }\n ],\n \"transaction\": {\n \"transaction_number\": \"TXN-250815-000538\",\n \"status\": \"completed\"\n },\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 1\n }\n}"}],"_postman_id":"4f411147-a680-4c70-8d0d-04212ce5d32b"},{"name":"Create Transaction Note","id":"8c5b517f-9598-48a6-b387-8f1649014a97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.sparkcrm.io/v1/transactions/{transactionNumber}/notes","description":"Create a new note for a specific transaction.
\nBearer Token from collection Spark CRM
\nUpdate an existing note for a specific transaction.
\nBearer Token from collection Spark CRM
\nNote: At least one field must be provided to update the note. All fields use \"sometimes\" validation, meaning they're only validated if present in the request.
\nDelete a specific note for a transaction by note ID.
\nBearer Token from collection Spark CRM
\nNo request body parameters. The transaction number and note ID are provided in the URL path.
\nList & Search for Gateways
\nRetrieve a paginated list of gateways available to the authenticated account. Supports free-text search and filtering by status.
\nGET https://api.sparkcrm.io/v1/gateways?status=active\nReturns a paginated list of all gateways currently in active status for the authenticated team. Combine with per_page, page, or search to narrow results.
Bearer Token from collection Spark CRM
\nRequired permission: api:gateways.view_any
Page number for paginated results
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"c3b950a6-0bcb-55d2-53ba-3b99b7043b93"},{"name":"Get Gateway","id":"d306a8fa-8afb-28b3-53e1-dc9d36563ee9","request":{"method":"GET","header":[],"url":"https://api.sparkcrm.io/v1/gateways/{{gatewayId}}","description":"Retrieve a Single Gateway
\nRetrieve a single gateway by its identifier (the team's internal gateway id). Database ids are never exposed.
\nGET https://api.sparkcrm.io/v1/gateways/1\nBearer Token from collection Spark CRM
\nRequired permission: api:gateways.view
Create a New Gateway
\nCreate a new gateway configuration for the authenticated account. Returns the detailed gateway object on success.
\nBearer Token from collection Spark CRM
\nRequired permission: api:gateways.create
201 Created — returns the full detailed gateway object identical to the Get Gateway response, plus:
{\n \"success\": true,\n \"message\": \"Gateway created successfully\"\n}\nPartially Update a Gateway
\nUpdate mutable fields on a gateway. All fields are optional; only validated fields will be saved. The identifier in the URL is the team's internal gateway id.
\nBearer Token from collection Spark CRM
\nRequired permission: api:gateways.update
All fields are optional. Only the fields included will be updated.
\n200 OK — returns the updated detailed gateway object plus:
{\n \"success\": true,\n \"message\": \"Gateway updated successfully\"\n}\nAggregated Performance Metrics for a Gateway
\nReturns aggregated transaction performance metrics for a single gateway over a date range. If no date filters are provided, defaults to the current calendar month.
\nGET https://api.sparkcrm.io/v1/gateways/1/metrics?start_date=2026-05-01&end_date=2026-05-31\nBearer Token from collection Spark CRM
\nRequired permission: api:gateways.metrics
{\n \"success\": true,\n \"data\": {\n \"gateway_id\": 1,\n \"date_range\": {\n \"start_date\": \"2026-05-01\",\n \"end_date\": \"2026-05-31\"\n },\n \"metrics\": {\n \"monthly_limit\": 1000000,\n \"attempts_count\": 1200,\n \"attempts_amount\": 250000.00,\n \"approved_count\": 800,\n \"approved_amount\": 180000.00,\n \"declined_count\": 400,\n \"declined_amount\": 70000.00,\n \"voids_count\": 50,\n \"voids_amount\": 10000.00,\n \"refunds_count\": 30,\n \"refunds_amount\": 8000.00,\n \"chargebacks_count\": 10,\n \"chargebacks_amount\": 5000.00\n }\n }\n}\nList & search affiliates for the authenticated account.
\nReturns a paginated, account-scoped list of affiliates ordered by created_at descending. Supports filtering by active status and a partial search across the affiliate name and custom_id. Each item in this list view returns the summary affiliate object; the sub-affiliate identifier fields and detailed throttle fields are only returned by the Get Affiliate, Create Affiliate, and Update Affiliate endpoints.
GET https://api.sparkcrm.io/v1/affiliates?is_active=1&search=AFF&per_page=15\nReturns active affiliates whose name or custom id contains AFF, 15 per page.
Bearer Token from collection Spark CRM
\nRequired permission: api:affiliates.view_any
Partial match against the affiliate's name OR custom_id (LIKE %search%). Maximum 255 characters.
\n","type":"text/plain"},"key":"search","value":"AFF"},{"description":{"content":"Filter by active status. Boolean — accepts 1, 0, true, false. Omit to return both active and inactive affiliates.
\n","type":"text/plain"},"key":"is_active","value":"1"},{"description":{"content":"Number of results per page. Minimum: 1, Maximum: 100. Default: 15.
\n","type":"text/plain"},"key":"per_page","value":"15"},{"disabled":true,"description":{"content":"Page number to retrieve when results span multiple pages. Minimum: 1. Default: 1.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"35903d77-7c51-ab7d-3f93-f341c810ebe1","name":"List Affiliates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparkcrm.io/v1/affiliates?search=AFF&is_active=1&per_page=15&page=1","protocol":"https","host":["api","sparkcrm","io"],"path":["v1","affiliates"],"query":[{"description":"Partial match against the affiliate's name OR custom_id (LIKE %search%). Maximum 255 characters.","key":"search","value":"AFF"},{"description":"Filter by active status. Boolean — accepts 1, 0, true, false. Omit to return both active and inactive affiliates.","key":"is_active","value":"1"},{"description":"Number of results per page. Minimum: 1, Maximum: 100. Default: 15.","key":"per_page","value":"15"},{"description":"Page number to retrieve when results span multiple pages. Minimum: 1. Default: 1.","key":"page","value":"1","disabled":true}]},"description":"# List Affiliates\n\n**List & search affiliates for the authenticated account.**\n\nReturns a paginated, account-scoped list of affiliates ordered by `created_at` descending. Supports filtering by active status and a partial search across the affiliate `name` and `custom_id`. Each item in this list view returns the summary affiliate object; the sub-affiliate identifier fields and detailed throttle fields are only returned by the **Get Affiliate**, **Create Affiliate**, and **Update Affiliate** endpoints.\n\n## Example — Search Active Affiliates\n\n```\nGET https://api.sparkcrm.io/v1/affiliates?is_active=1&search=AFF&per_page=15\n```\n\nReturns active affiliates whose name or custom id contains `AFF`, 15 per page.\n\n## Authorization\n\nBearer Token from collection Spark CRM\n\n**Required permission:** `api:affiliates.view_any`\n\n## Request Object\n\n| Request Field | Description |\n| --- | --- |\n| **search** | _**string (optional)**_Create a new affiliate for the authenticated account.
\nCreates an account-scoped affiliate. name and custom_id are required; custom_id must be unique within your account (the uniqueness check ignores soft-deleted affiliates). All throttle and sub-affiliate fields are optional and fall back to their model defaults when omitted. The response returns the detailed affiliate object including the sub-affiliate identifier fields and full throttle configuration.
Bearer Token from collection Spark CRM
\nRequired permission: api:affiliates.create
Retrieve a single affiliate by its custom id (account-scoped).
\nLooks up an affiliate by its custom_id within the authenticated account and returns the detailed affiliate object — including the sub-affiliate identifier fields and full throttle configuration that are omitted from the list view. Returns 404 if no affiliate with that custom_id exists for your account.
Bearer Token from collection Spark CRM
\nRequired permission: api:affiliates.view
Partially update an affiliate by its custom id (account-scoped).
\nPartial update — every field is optional and only the fields you send are validated and saved (sometimes rules). Omitted fields are left unchanged. The affiliate is matched by custom_id within your account. If you change custom_id, the new value must remain unique within your account (the current affiliate is excluded from the uniqueness check). The response returns the detailed affiliate object reflecting the saved changes.
Bearer Token from collection Spark CRM
\nRequired permission: api:affiliates.update
All fields are optional; only the fields present in the request are validated and updated.
\nSoft delete an affiliate by its custom id (account-scoped).
\nSoft-deletes the affiliate matched by custom_id within the authenticated account. The record is retained in the database with a deleted_at timestamp (not permanently removed), so the freed custom_id may be reused by a new affiliate. Returns 404 if no affiliate with that custom_id exists for your account.
Bearer Token from collection Spark CRM
\nRequired permission: api:affiliates.delete
Retrieve every automated email responder configured across all of your campaigns.
\nReturns a paginated list of auto responders belonging to the authenticated account. Auto responders are account-scoped through their parent campaign, so this endpoint aggregates responders from every campaign on the team. Results are ordered by creation date, newest first. This endpoint is read-only.
\nBearer Token from collection Spark CRM
\nRequired permission: api:auto_responders.view_any
Returns success: true, a data array of auto responder objects, and a pagination object.
Request
\nGET /v1/auto-responders?is_active=true&per_page=15&page=1\nAuthorization: Bearer <token>\nResponse 200 OK
{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"9b2f4c10-7e3a-4d6b-8a91-2c5f0e1d4abc\",\n \"campaign_id\": 1042,\n \"name\": \"Order Confirmation Email\",\n \"is_active\": true,\n \"trigger_types\": [\"order_confirmation\"],\n \"trigger_conditions\": null,\n \"delay_minutes\": 0,\n \"email_template_id\": 318,\n \"smtp_provider_id\": 12,\n \"excluded_products\": [],\n \"created_at\": \"2026-05-14T16:22:08.000000Z\",\n \"updated_at\": \"2026-06-02T09:41:55.000000Z\"\n }\n ],\n \"pagination\": {\n \"total\": 1,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 1\n }\n}\nOptional boolean filter. When present, returns only responders with the given active state. Accepts true/false (also 1/0). Omit to return both active and inactive responders.
\n","type":"text/plain"},"key":"is_active","value":"true"},{"description":{"content":"Optional integer. Results per page. Min 1, max 100. Defaults to 15 when omitted.
\n","type":"text/plain"},"key":"per_page","value":"15"},{"description":{"content":"Optional integer. Page number to retrieve. Min 1. Defaults to 1.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"505c1a25-671b-b1f6-60fe-f8e072cdbc77","name":"List Auto Responders","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparkcrm.io/v1/auto-responders?is_active=true&per_page=15&page=1","protocol":"https","host":["api","sparkcrm","io"],"path":["v1","auto-responders"],"query":[{"description":"Optional boolean filter. When present, returns only responders with the given active state. Accepts true/false (also 1/0). Omit to return both active and inactive responders.","value":"true","key":"is_active"},{"description":"Optional integer. Results per page. Min 1, max 100. Defaults to 15 when omitted.","value":"15","key":"per_page"},{"description":"Optional integer. Page number to retrieve. Min 1. Defaults to 1.","value":"1","key":"page"}]},"description":"# List Auto Responders\n\n**Retrieve every automated email responder configured across all of your campaigns.**\n\nReturns a paginated list of auto responders belonging to the authenticated account. Auto responders are account-scoped through their parent campaign, so this endpoint aggregates responders from every campaign on the team. Results are ordered by creation date, newest first. This endpoint is read-only.\n\n## Authorization\n\nBearer Token from collection Spark CRM\n\n**Required permission:** `api:auto_responders.view_any`\n\n## Request Object\n\n| Request Field | Description |\n| --- | --- |\n| `is_active` | _**boolean (optional)**_ Filter by active state. When present, only responders matching the given state are returned. Accepts `true`/`false` (also `1`/`0`). Omit to return all responders regardless of state. |\n| `per_page` | _**integer (optional)**_ Number of results per page. Min `1`, max `100`. Defaults to `15`. |\n| `page` | _**integer (optional)**_ Page number to retrieve. Min `1`. Defaults to `1`. |\n\n## Response Object\n\nReturns `success: true`, a `data` array of auto responder objects, and a `pagination` object.\n\n| Field | Description |\n| --- | --- |\n| `data[].id` | The auto responder's UUID. |\n| `data[].campaign_id` | Internal numeric ID of the parent campaign. |\n| `data[].name` | Human-readable name of the auto responder. |\n| `data[].is_active` | Boolean indicating whether the responder is enabled. |\n| `data[].trigger_types` | Array of trigger event strings that fire this responder (e.g. `order_confirmation`, `order_shipped`). |\n| `data[].trigger_conditions` | Object of additional conditions controlling when the responder fires (e.g. `days_before_billing`). May be `null`. |\n| `data[].delay_minutes` | Integer number of minutes to wait after the trigger event before sending. |\n| `data[].email_template_id` | Internal ID of the email template used for the message. May be `null`. |\n| `data[].smtp_provider_id` | Internal ID of the SMTP provider used to send. May be `null`. |\n| `data[].excluded_products` | Array of product IDs excluded from this responder. May be `null`. |\n| `data[].created_at` | ISO 8601 timestamp of creation. |\n| `data[].updated_at` | ISO 8601 timestamp of last update. |\n| `pagination.total` | Total number of matching responders. |\n| `pagination.per_page` | Results per page. |\n| `pagination.current_page` | Current page number. |\n| `pagination.last_page` | Last available page number. |\n| `pagination.from` | Index of the first item on the current page (`null` if empty). |\n| `pagination.to` | Index of the last item on the current page (`null` if empty). |\n\n## Errors\n\n| Code | Meaning |\n| --- | --- |\n| `403` | Missing the `api:auto_responders.view_any` permission. |\n| `422` | Validation error (e.g. `per_page` out of range, non-boolean `is_active`). |\n\n## Example\n\n**Request**\n\n```\nGET /v1/auto-responders?is_active=true&per_page=15&page=1\nAuthorization: BearerRetrieve a single automated email responder by its UUID.
\nReturns the full detail of one auto responder identified by its UUID. The responder is account-scoped through its parent campaign; requesting a UUID that does not belong to the authenticated team returns a 404. This endpoint is read-only.
\nBearer Token from collection Spark CRM
\nRequired permission: api:auto_responders.view
Returns success: true and a data object describing the auto responder.
Request
\nGET /v1/auto-responders/9b2f4c10-7e3a-4d6b-8a91-2c5f0e1d4abc\nAuthorization: Bearer <token>\nResponse 200 OK
{\n \"success\": true,\n \"data\": {\n \"id\": \"9b2f4c10-7e3a-4d6b-8a91-2c5f0e1d4abc\",\n \"campaign_id\": 1042,\n \"name\": \"Order Confirmation Email\",\n \"is_active\": true,\n \"trigger_types\": [\"order_confirmation\"],\n \"trigger_conditions\": null,\n \"delay_minutes\": 0,\n \"email_template_id\": 318,\n \"smtp_provider_id\": 12,\n \"excluded_products\": [],\n \"created_at\": \"2026-05-14T16:22:08.000000Z\",\n \"updated_at\": \"2026-06-02T09:41:55.000000Z\"\n }\n}\nResponse 404 Not Found
{\n \"success\": false,\n \"message\": \"Auto responder not found\"\n}\nReturns every gateway assigned to a payment router, ordered by routing priority.
\nFetches the gateway assignments attached to a single payment router (orchestrator). Each item in the response represents one gateway-to-router link together with its routing pivot settings (priority, weight, caps, decline/fail limits) and live counters. Results are always sorted ascending by priority. The router is resolved by its internal_id (the {router_id} path segment), scoped to the authenticated team.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.gateways.view
This endpoint takes no query parameters and returns the full (non-paginated) list of gateway assignments for the router.
\nReturns success: true and a data array. Each element is an OrchestratorGatewayResource:
GET /v1/payment-routers/123/gateways
Attaches an existing team gateway to a payment router with its routing settings.
\nCreates a new gateway assignment on the router identified by {router_id}. The gateway_id in the body is the gateway's internal_id (the team-facing id), which is resolved to the gateway record for the authenticated team. A gateway can only be attached to a given router once; attempting to attach a gateway that is already assigned returns a 422 validation error. On success the new assignment is returned with status 201.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.gateways.attach
Path parameter router_id (integer, required) is the router's internal_id.
Returns success: true, a message, and the created assignment under data as an OrchestratorGatewayResource (same field shape as the list endpoint). gateway_id is echoed back as the gateway's internal_id.
POST /v1/payment-routers/123/gateways
Updates the routing settings of a gateway already assigned to a payment router.
\nPartially updates an existing gateway assignment on the router identified by {router_id}. The {gateway_id} path segment is the gateway's internal_id, resolved to the assignment for the authenticated team. All body fields are optional (sometimes) — only the fields you send are updated. The gateway itself cannot be changed here; to swap gateways, detach and attach.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.gateways.update
All fields use sometimes, so only supplied fields are modified.
Path parameters: router_id (integer, required) — router internal_id; gateway_id (integer, required) — gateway internal_id.
Returns success: true, a message, and the refreshed assignment under data as an OrchestratorGatewayResource (same field shape as the list endpoint).
PATCH /v1/payment-routers/123/gateways/7
Detaches a gateway from a payment router.
\nRemoves the gateway assignment identified by {gateway_id} (the gateway's internal_id) from the router identified by {router_id}, for the authenticated team. The gateway record itself is not deleted — only its link to this router. Returns a simple success message; no resource body is included.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.gateways.detach
Returns success: true and a confirmation message. No data payload is returned.
DELETE /v1/payment-routers/123/gateways/7
Retrieve every routing rule configured for a payment router.
\nReturns all routing rules belonging to the specified payment router, ordered ascending by priority. Each rule includes its match conditions and the target_gateway_id (the gateway's internal_id) that traffic is routed to when the conditions match. The payment router is resolved by its internal_id (the {router_id} path segment) and is scoped to the authenticated team.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.rules.view
This endpoint takes no query parameters and is not paginated; the full ordered collection is returned.
\nReturns success: true and a data array. Each element is a routing rule object:
GET /v1/payment-routers/123/rules
Add a new routing rule to a payment router.
\nCreates a routing rule under the payment router identified by the {router_id} path segment (the router's internal_id, scoped to the authenticated team). A rule consists of a set of conditions that are all matched (AND logic) against an incoming transaction, and a target_gateway_id that traffic is routed to when every condition matches.
The target_gateway_id you send is the gateway's internal_id; it is resolved to a gateway owned by the authenticated team. If no such gateway exists for the account, a 422 validation error is returned.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.rules.create
On success returns 201 with success: true, a message, and the created rule under data using the routing rule object shape (see List Routing Rules → Response Object). target_gateway_id in the response is the gateway's internal_id.
POST /v1/payment-routers/123/rules
Modify an existing routing rule on a payment router.
\nUpdates the routing rule identified by {rule_id} (the rule's internal_id) within the payment router identified by {router_id} (the router's internal_id). Both are scoped to the authenticated team. All fields are optional on update (sometimes) — only the fields you send are validated and applied. When conditions is supplied it fully replaces the existing conditions array.
When target_gateway_id is supplied, it is treated as the gateway's internal_id and resolved to a gateway owned by the authenticated team; an unknown value returns a 422.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.rules.update
All fields are optional (sometimes). When present they must satisfy the rules below.
On success returns 200 with success: true, a message, and the updated rule under data using the routing rule object shape (see List Routing Rules → Response Object).
PATCH /v1/payment-routers/123/rules/7
Permanently remove a routing rule from a payment router.
\nDeletes the routing rule identified by {rule_id} (the rule's internal_id) within the payment router identified by {router_id} (the router's internal_id). Both are scoped to the authenticated team. Returns a confirmation message on success.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.rules.delete
Returns 200 with success: true and a confirmation message. No rule object is returned.
DELETE /v1/payment-routers/123/rules/7
List & Search for Payment Routers
\nRetrieve a paginated list of payment routers (orchestrators) available to the authenticated account. Supports free-text search and filtering by active status. Results are ordered by creation date (newest first).
\nGET https://api.sparkcrm.io/v1/payment-routers?is_active=true\nReturns a paginated list of all payment routers currently active for the authenticated team. Combine with per_page, page, or search to narrow results.
Bearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.view_any
List responses return the summary representation of each router (the detailed email_tokens, bin_configurations, and mcc_configurations arrays are only returned by the detail, create, and update endpoints).
Search across router name and internal id. When the value is all digits it is matched against internal_id; otherwise it is matched against name. Maximum 255 characters.
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Filter by active status. Boolean (true/false, 1/0).
\n","type":"text/plain"},"key":"is_active","value":"true"},{"description":{"content":"Number of results per page. Minimum: 1, Maximum: 100. Default: 15
\n","type":"text/plain"},"key":"per_page","value":"15"},{"disabled":true,"description":{"content":"Page number to retrieve when results span multiple pages. Used together with per_page. Default: 1
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"47f71f13-b263-b23a-07be-9d22e171ced8","name":"List Payment Routers","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparkcrm.io/v1/payment-routers?is_active=true&per_page=15&page=1","protocol":"https","host":["api","sparkcrm","io"],"path":["v1","payment-routers"],"query":[{"description":"Search across router name and internal id. When the value is all digits it is matched against internal_id; otherwise it is matched against name. Maximum 255 characters.","key":"search","value":"","disabled":true},{"description":"Filter by active status. Boolean (true/false, 1/0).","key":"is_active","value":"true","disabled":true},{"description":"Number of results per page. Minimum: 1, Maximum: 100. Default: 15","key":"per_page","value":"15"},{"description":"Page number to retrieve when results span multiple pages. Used together with per_page. Default: 1","key":"page","value":"1","disabled":true}]},"description":"# List Payment Routers\n\n**List & Search for Payment Routers**\n\nRetrieve a paginated list of payment routers (orchestrators) available to the authenticated account. Supports free-text search and filtering by active status. Results are ordered by creation date (newest first).\n\n## Example — Search for Active Payment Routers\n\n```\nGET https://api.sparkcrm.io/v1/payment-routers?is_active=true\n```\n\nReturns a paginated list of all payment routers currently active for the authenticated team. Combine with `per_page`, `page`, or `search` to narrow results.\n\n## Authorization\n\nBearer Token from collection Spark CRM\n\n**Required permission:** `api:payment_routers.view_any`\n\n## Request Object\n\n| Request Field | Description |\n| --- | --- |\n| **search** | _**string (optional)**_Create a New Payment Router
\nCreate a new payment router (orchestrator) for the authenticated account. A payment router decides which gateway a transaction is sent to based on its routing algorithm, weighting, failover, and any BIN / MCC / email-token overrides. Returns the detailed router object on success.
\nBearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.create
201 Created — returns the full detailed router object identical to the Get Payment Router response (minus the gateways_count / routing_rules_count counts, which are only loaded by the detail endpoint), plus:
{\n \"success\": true,\n \"message\": \"Payment router created successfully\"\n}\nRetrieve a Single Payment Router
\nRetrieve a single payment router (orchestrator) by its identifier (the team's internal router id). Database ids are never exposed. Returns the detailed representation including configuration arrays and counts of associated gateways and routing rules.
\nGET https://api.sparkcrm.io/v1/payment-routers/12\nBearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.view
Partially Update a Payment Router
\nUpdate mutable fields on a payment router (orchestrator). All fields are optional; only the validated fields included in the request body will be saved. The identifier in the URL is the team's internal router id.
\nBearer Token from collection Spark CRM
\nRequired permission: api:payment_routers.update
All fields are optional. Only the fields included will be updated.
\n200 OK — returns the updated detailed router object plus:
{\n \"success\": true,\n \"message\": \"Payment router updated successfully\"\n}\nRetrieve a paginated, searchable list of the decline salvage profiles owned by your account.
\nReturns every decline salvage profile belonging to the authenticated account, newest first. Each profile defines how declined transactions are automatically retried (the retry schedule, attempt limits, amount/window bounds, and excluded decline codes). The list view returns a summary of each profile; use the Get Decline Salvage Profile endpoint to retrieve the full object including the retry_schedule and excluded_decline_codes arrays.
Bearer Token from collection Spark CRM
\nRequired permission: api:decline_salvage_profiles.view_any
Returns success: true, a data array of profile summary objects, and a pagination object. Each item in data contains:
The summary list intentionally omits retry_schedule and excluded_decline_codes; both are returned by the Get/Create/Update endpoints.
The pagination object contains total, per_page, current_page, last_page, from, and to.
GET /v1/decline-salvage-profiles?per_page=15&page=1&is_active=true
Optional. Case-insensitive partial match against the profile name. string, max 255 characters.
\n","type":"text/plain"},"key":"search","value":"Standard"},{"disabled":true,"description":{"content":"Optional. Filter by active state. boolean (true/false, 1/0). When present, returns only profiles whose is_active matches.
\n","type":"text/plain"},"key":"is_active","value":"true"},{"description":{"content":"Optional. Results per page. integer, min 1, max 100. Defaults to 15.
\n","type":"text/plain"},"key":"per_page","value":"15"},{"description":{"content":"Optional. Page number to retrieve. integer, min 1. Defaults to 1.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"1387edcd-784b-a972-d7f4-d404e5001b62","name":"List Decline Salvage Profiles","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sparkcrm.io/v1/decline-salvage-profiles?per_page=15&page=1&search=Standard&is_active=true","protocol":"https","host":["api","sparkcrm","io"],"path":["v1","decline-salvage-profiles"],"query":[{"key":"search","description":"Optional. Case-insensitive partial match against the profile name. string, max 255 characters.","value":"Standard"},{"key":"is_active","description":"Optional. Filter by active state. boolean (true/false, 1/0). When present, returns only profiles whose is_active matches.","value":"true","disabled":true},{"key":"per_page","description":"Optional. Results per page. integer, min 1, max 100. Defaults to 15.","value":"15"},{"key":"page","description":"Optional. Page number to retrieve. integer, min 1. Defaults to 1.","value":"1"}]},"description":"# List Decline Salvage Profiles\n\n**Retrieve a paginated, searchable list of the decline salvage profiles owned by your account.**\n\nReturns every decline salvage profile belonging to the authenticated account, newest first. Each profile defines how declined transactions are automatically retried (the retry schedule, attempt limits, amount/window bounds, and excluded decline codes). The list view returns a summary of each profile; use the **Get Decline Salvage Profile** endpoint to retrieve the full object including the `retry_schedule` and `excluded_decline_codes` arrays.\n\n## Authorization\n\nBearer Token from collection Spark CRM\n\n**Required permission:** `api:decline_salvage_profiles.view_any`\n\n## Request Object\n\n| Request Field | Description |\n| --- | --- |\n| `search` | _**string (optional)**_ Case-insensitive partial match against the profile `name`. Max 255 characters. |\n| `is_active` | _**boolean (optional)**_ Filter by active state. Accepts `true`/`false` or `1`/`0`. When omitted, profiles of all states are returned. |\n| `per_page` | _**integer (optional)**_ Number of results per page. Min `1`, max `100`. Defaults to `15`. |\n| `page` | _**integer (optional)**_ Page number to retrieve. Min `1`. Defaults to `1`. |\n\n## Response Object\n\nReturns `success: true`, a `data` array of profile summary objects, and a `pagination` object. Each item in `data` contains:\n\n| Field | Description |\n| --- | --- |\n| `id` | _integer_ The profile's account-scoped id (`internal_id`). Use this value in the path of the Get/Update endpoints. |\n| `name` | _string_ The profile name. |\n| `salvage_type` | _string_ One of `standard` or `custom`. |\n| `transaction_type` | _string\\|null_ Which transactions the profile applies to: `initial`, `rebill`, or `both`. |\n| `is_active` | _boolean_ Whether the profile is enabled. |\n| `is_default` | _boolean_ Whether this is the account default profile (only one per account). |\n| `auto_apply_to_new` | _boolean_ Whether the profile is automatically applied to newly created campaigns. |\n| `fire_affiliate_pixels` | _boolean_ Whether affiliate pixels fire on a successful salvage. |\n| `max_attempts` | _integer\\|null_ Maximum number of retry attempts. |\n| `minimum_retry_interval` | _integer\\|null_ Minimum delay before the first retry, in minutes. |\n| `maximum_retry_window` | _integer\\|null_ Maximum window over which retries are attempted, in minutes. |\n| `minimum_amount` | _string\\|null_ Lower transaction-amount bound (decimal, 2 places). Transactions below this are not salvaged. |\n| `maximum_amount` | _string\\|null_ Upper transaction-amount bound (decimal, 2 places). Transactions above this are not salvaged. |\n| `created_at` | _string\\|null_ ISO 8601 creation timestamp. |\n| `updated_at` | _string\\|null_ ISO 8601 last-updated timestamp. |\n\nThe summary list intentionally omits `retry_schedule` and `excluded_decline_codes`; both are returned by the Get/Create/Update endpoints.\n\nThe `pagination` object contains `total`, `per_page`, `current_page`, `last_page`, `from`, and `to`.\n\n## Errors\n\n| Status | Meaning |\n| --- | --- |\n| `403` | Token lacks the `api:decline_salvage_profiles.view_any` (or legacy `api:view_any`) permission. |\n| `422` | Validation error on a query parameter (e.g. `per_page` above 100). |\n\n## Example\n\n`GET /v1/decline-salvage-profiles?per_page=15&page=1&is_active=true`"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1042,\n \"name\": \"Standard Recovery\",\n \"salvage_type\": \"standard\",\n \"transaction_type\": \"both\",\n \"is_active\": true,\n \"is_default\": true,\n \"auto_apply_to_new\": true,\n \"fire_affiliate_pixels\": false,\n \"max_attempts\": 4,\n \"minimum_retry_interval\": 45,\n \"maximum_retry_window\": 2160,\n \"minimum_amount\": \"1.00\",\n \"maximum_amount\": \"500.00\",\n \"created_at\": \"2026-05-30T14:22:05.000000Z\",\n \"updated_at\": \"2026-06-12T09:01:44.000000Z\"\n },\n {\n \"id\": 1039,\n \"name\": \"Aggressive Recovery\",\n \"salvage_type\": \"custom\",\n \"transaction_type\": \"rebill\",\n \"is_active\": true,\n \"is_default\": false,\n \"auto_apply_to_new\": false,\n \"fire_affiliate_pixels\": true,\n \"max_attempts\": 4,\n \"minimum_retry_interval\": 30,\n \"maximum_retry_window\": 4320,\n \"minimum_amount\": null,\n \"maximum_amount\": null,\n \"created_at\": \"2026-05-21T18:47:11.000000Z\",\n \"updated_at\": \"2026-05-21T18:47:11.000000Z\"\n }\n ],\n \"success\": true,\n \"pagination\": {\n \"total\": 2,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 1,\n \"from\": 1,\n \"to\": 2\n }\n}"}],"_postman_id":"3aa0de23-0b7a-1672-fa73-4dbd5b7555b2"},{"name":"Create Decline Salvage Profile","id":"54a24691-4afb-4536-25f3-ca0e1461f067","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Aggressive Recovery\",\n \"salvage_type\": \"custom\",\n \"transaction_type\": \"both\",\n \"is_active\": true,\n \"is_default\": false,\n \"auto_apply_to_new\": false,\n \"fire_affiliate_pixels\": true,\n \"retry_schedule\": [\n { \"attempt\": 1, \"delay\": 30 },\n { \"attempt\": 2, \"delay\": 120 },\n { \"attempt\": 3, \"delay\": 360 }\n ],\n \"max_attempts\": 4,\n \"minimum_retry_interval\": 30,\n \"maximum_retry_window\": 4320,\n \"excluded_decline_codes\": [\"fraud\", \"stolen_card\", \"lost_card\"],\n \"minimum_amount\": 1.00,\n \"maximum_amount\": 500.00\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sparkcrm.io/v1/decline-salvage-profiles","description":"Create a new decline salvage profile for your account.
\nDefines a reusable strategy for automatically retrying declined transactions. A profile controls which transactions are eligible (by type and amount), how many times and how often retries are attempted, and which decline codes are excluded from salvage. The created profile is returned in full (including retry_schedule and excluded_decline_codes).
\n\nNote on
\nretry_schedule: Whensalvage_typeisstandard, theretry_scheduleis set automatically to the built-in schedule (attempt 1 = 45 min, 2 = 180 min, 3 = 360 min, 4 = 2160 min) and anyretry_scheduleyou supply is ignored. Supply a customretry_scheduleonly whensalvage_typeiscustom.
\n\nNote on
\nis_default: Settingis_defaulttotrueautomatically clears the default flag on any other profile in your account, ensuring at most one default profile.
Bearer Token from collection Spark CRM
\nRequired permission: api:decline_salvage_profiles.create
Returns success: true, a message, and the full created profile in data. The detailed response includes all summary fields plus retry_schedule and excluded_decline_codes. The id field is the profile's account-scoped internal_id. Amount fields are returned as decimal strings with 2 places.
POST /v1/decline-salvage-profiles with the request body shown returns the 201 response below.
Retrieve a single decline salvage profile by id.
\nReturns the full decline salvage profile identified by {profile_id}, including the retry_schedule and excluded_decline_codes arrays that the list endpoint omits. The lookup is account-scoped: a profile that does not belong to the authenticated account returns 404.
Bearer Token from collection Spark CRM
\nRequired permission: api:decline_salvage_profiles.view
Returns success: true and the full profile in data:
GET /v1/decline-salvage-profiles/1043
Partially update an existing decline salvage profile.
\nApplies a partial (PATCH) update to the profile identified by {profile_id}. Every field is optional; only the fields you send are validated and saved. The lookup is account-scoped, so updating a profile that does not belong to the authenticated account returns 404. The full updated profile (including retry_schedule and excluded_decline_codes) is returned.
\n\nNote on
\nsalvage_type: Changingsalvage_typetostandarddoes not re-apply the built-in schedule on update (the default schedule is only seeded at creation). To change retry timing on an existing profile, send an explicitretry_schedule.
\n\nNote on
\nis_default: Settingis_defaulttotrueunsets the default flag on all other profiles in your account.
Bearer Token from collection Spark CRM
\nRequired permission: api:decline_salvage_profiles.update
All fields are optional. When a field is present it must satisfy the same rules as on create.
\nReturns success: true, a message, and the full updated profile in data (detailed shape, including retry_schedule and excluded_decline_codes).
PATCH /v1/decline-salvage-profiles/1043 with the request body shown returns the 200 response below.
The REST API is used to create, read, update, and delete all system resources, so companies can build truly headless e-commerce experiences without having to do all the integrations Spark has already done.
\nThis comprehensive API provides full access to your Spark CRM resources including campaigns, products, orders, customers, and more. Designed with flexibility in mind, the REST API enables developers to build custom integrations, dashboards, and automated workflows while leveraging Spark's powerful e-commerce infrastructure. The API follows RESTful conventions and returns consistent JSON responses across all endpoints.
\nRegister for a Spark CRM account to get started
\nInclude your API key in all requests as a Bearer token in the Authorization header:\nAuthorization: Bearer YOUR_API_KEY_HERE
All authenticated endpoints require this header to be present with a valid API key.
\nThis is a JSON API and requires proper headers for all requests:
\nContent-Type: application/jsonAccept: application/jsonIf these headers are not included, the API will return a 400 Bad Request response with an error message indicating which header is missing or incorrect, such as \"Content-Type must be application/json\" or \"Accept must be application/json\".
\nDifferent API endpoints require specific permissions. Your API key must have the appropriate permissions assigned to access each endpoint:
\nIf your API key lacks the necessary permissions, you'll receive a 403 Forbidden response with the message \"Unauthorized. Token lacks the necessary permissions.\"
\nTo ensure system stability and fair usage, API requests are subject to the below rate limiting per account:
\nWhen a rate limit is exceeded, the API will return a 429 Too Many Requests response with the following headers:
\nAll REST API requests should be made to:\nhttps://api.sparkcrm.io/v1
List endpoints support pagination to help you manage large datasets efficiently:
\nPaginated responses include a pagination object with the following structure:
{\n \"success\": true,\n \"data\": [...],\n \"pagination\": {\n \"total\": 150,\n \"per_page\": 15,\n \"current_page\": 1,\n \"last_page\": 10,\n \"from\": 1,\n \"to\": 15\n }\n}\nMany endpoints support filtering and search capabilities:
\nSearch parameters typically perform partial matches across multiple fields (e.g., name, internal_id) using SQL LIKE operations.
\nResources can be identified using multiple identifiers for flexibility:
\n123)550e8400-e29b-41d4-a716-446655440000)The API automatically detects the identifier type - numeric values are treated as internal IDs, while non-numeric values are treated as UUIDs.
\nSpark CRM uses conventional HTTP response codes to indicate the success or failure of an API request. In general:
\n2xx range indicate success4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, invalid object passed, etc.)5xx range indicate an error with Spark CRM's servers (these are rare)All 4xx and 5xx errors return an error message via the \"errors\" field.
{\n \"success\": false,\n \"message\": \"Validation error\",\n \"errors\": {\n \"identifier\": [\n \"The identifier field is required.\"\n ],\n \"per_page\": [\n \"The per page field must be between 1 and 15.\"\n ]\n }\n}\nIf there is no data for a response field, the API will use null for that field's value.
All API responses follow a consistent format:
\n{\n \"success\": true,\n \"data\": {...},\n \"pagination\": {...} // Only present for paginated responses\n}\n{\n \"success\": false,\n \"message\": \"Error description\",\n \"errors\": {...}, // Validation errors (when applicable)\n \"error\": \"Technical error message\" // Server errors (when applicable)\n}\n1999\"US\", \"CA\", \"GB\")\"USD\", \"EUR\", \"GBP\")All API requests are automatically scoped to your team/account. You can only access resources that belong to your team, ensuring complete data isolation and security.
\n","_postman_id":"c4f0fc4e-e02d-4dcd-9588-fad410f8bb95","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","name":"Spark CRM","type":"collection"}}},{"name":"Enrichment","item":[{"name":"Email Validation","id":"7d07dd7d-233a-4414-864e-cf846f094051","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"When email validation is enabled, the following structure is returned in the enrichment.email object:
\nWhen phone validation is enabled, the following structure is returned in the enrichment.phone object:
\nWhen address verification is enabled, the following structure is returned in the enrichment.address object:
\nSpark CRM's enrichment services provide real-time validation and standardization for customer data during checkout. When enabled, these services automatically validate email addresses, phone numbers, and shipping addresses to reduce fraud, improve deliverability, and ensure accurate fulfillment.
\nTo use enrichment services:
\nWhen enrichment services are enabled:
\nenrichment response objectEnrichment data is automatically included in responses from:
\nPOST /checkout/orders - Create OrderPOST /checkout/orders/payment - Process PaymentPOST /checkout/leads - Create Lead (when enrich=true parameter is included)GET /checkout/orders - Search Orders (for orders processed with enrichment enabled)Each enrichment service is billed per validation. Contact support@sparkcrm.io for pricing details.
\n","_postman_id":"f0661368-c1f5-4053-abcb-c1b13f056a79","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","id":"53f3b62c-89a1-4d64-8456-aac75f451f9c","name":"Spark CRM","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"d3d7ec52-5d69-440f-8239-1f5fc232dfac","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"93ee4ca0-d48e-4b11-8412-a2ae392a252b","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"id":"93302e77-7d5f-496d-8f18-e6ed3daebb74","key":"api_token","value":"","type":"string"}]}