NUMU Docs
Contact
API
ThemesPartner Apps
API
ThemesPartner Apps
  1. Settings & money
  • 🗂️ Overview
  • 🚀 Quickstart
  • Authentication
  • Webhooks
  • Errors
  • Pagination
  • Rate limits
  • API terms
  • Versioning
  • Changelog
  • Merchant APIs
    • Identity
      • Get current user
      • Identify the calling personal access token
    • Catalog
      • Create new product
      • List products
      • Get product by ID
      • Update product
      • Delete product
      • Upload product image
      • Delete product image
      • Set product image alt text
      • Download CSV import template
      • Import products from CSV
      • Export products as CSV
      • List variants for a product
      • Create a variant
      • Update a variant
      • Delete a variant
      • List gift cards
      • Issue a new gift card
      • Get gift card
      • List gift card transactions
      • Void a gift card (zero remaining balance)
      • Get inventory list
      • Get inventory statistics
      • Adjust stock level
      • Bulk adjust stock levels
      • List all inventory levels for a store
      • List inventory levels for a variant
      • List inventory levels at a location
      • Set inventory level at a location
      • List inventory transfers
      • Create a draft transfer
      • Get transfer
      • Replace lines (DRAFT only)
      • Move transfer through its state machine
      • Create new category
      • List categories
      • Get category by ID
      • Update category
      • Delete category
      • Upload category image
      • Create upsell rule
      • List upsell rules
      • Get upsell rule
      • Update upsell rule
      • Delete upsell rule
      • Create product bundle
      • List bundles for a store or product
      • Set bundles for a product (replace all)
      • Get bundle details
      • Update bundle
      • Delete bundle
      • Reorder bundles
    • Orders & fulfillment
      • List payment proofs for an order
      • List manual-payment orders awaiting merchant review
      • Create new order
      • List orders
      • Create a draft order
      • Convert draft order to a real order
      • List COD Autopilot exception orders
      • Resolve (dismiss) a COD Autopilot exception
      • Per-status order counts (list tab badges)
      • Update order
      • Cancel order
      • Update order status
      • Mark order as paid
      • Undo a manual mark-paid (payment back to pending)
      • Customer kept part of the order at the door
      • Get order timeline
      • List order activity stream (staff comments + system events)
      • Add a staff comment to an order
      • Bulk update order statuses
      • Resend order status email
      • Preview order status email
      • WhatsApp sends for an order
      • Resend the WhatsApp order confirmation
      • Abandoned vs recovered carts — counts, value, payback
      • List abandoned checkouts for a store
      • Get an abandoned checkout
      • Send a recovery email to the abandoned-checkout's customer
      • Manually mark an abandoned checkout as recovered
      • Turn an abandoned checkout into a real COD order
      • Send a WhatsApp abandoned-cart recovery nudge
      • Preview a CSV order import (parses headers + suggests mapping)
      • Execute a CSV order import with a confirmed mapping
      • List the target fields the importer understands
      • Send the order's payment link into a linked conversation
      • Request a refund for an order
      • List refunds for an order
      • Get refund details
      • Approve a refund request
      • Reject a refund request
      • Process a refund through payment provider
      • List all refunds for a store
      • List returns for the store
      • Get one return
      • Approve a pending return
      • Reject a return
      • Mark a return as physically received
      • Issue refund for a received return
      • Carrier catalog with this store's connection state
      • Save credentials for a carrier
      • Disconnect a carrier
      • Verify a carrier's stored credentials
      • Change a connected carrier's settings
      • Known Egyptian couriers to start from
      • This store's courier profiles
      • Add a courier
      • Update a courier
      • Remove a courier
      • Print waybills for a batch of shipments
      • Print one waybill
      • Export the pickup manifest as CSV
      • Preview a courier's status sheet
      • Apply reviewed status rows
      • Create shipment
      • List shipments
      • Bulk create shipments
      • Shipment dashboard stats
      • COD reconciliation summary
      • List pickups
      • Schedule a pickup
      • Get shipment detail
      • Update shipment on Bosta
      • Cancel shipment
      • Request return shipment
      • Track shipment
      • Print AWB (Air Waybill)
      • Get delivery details from Bosta
      • Get business pickup locations
      • Get pickup details
      • Update pickup
      • Cancel pickup
      • Get Bosta cities
      • Get zones in a city
      • Record an out-of-band payment against an order
      • Get order by ID or order number
    • Settings & money
      • Stream a payment proof image (merchant-authenticated)
        GET
      • Approve a customer-submitted proof
        POST
      • Reject a customer-submitted proof
        POST
      • Find perceptually similar prior proofs in this store
        GET
      • Create new invoice
        POST
      • List store invoices
        GET
      • Get invoice details
        GET
      • Update draft invoice
        PATCH
      • Delete draft invoice
        DELETE
      • Submit invoice to ETA
        POST
      • Download invoice PDF
        GET
      • Get (or create) the invoice for an order
        GET
      • List locations
        GET
      • Create location
        POST
      • Get location
        GET
      • Update location
        PUT
      • Delete location
        DELETE
      • Get all store settings
        GET
      • Get payment settings
        GET
      • Update payment settings
        PATCH
      • Get COD trust network protection settings
        GET
      • Update COD trust network protection settings
        PATCH
      • Get COD Autopilot settings
        GET
      • Update COD Autopilot settings
        PATCH
      • Get storefront password-protection status
        GET
      • Enable/disable storefront password & set the password
        PUT
      • Get the store's custom product-label definitions
        GET
      • Replace the store's custom product-label definitions
        PUT
      • Save Paymob credentials
        PUT
      • Get Paymob credentials status
        GET
      • Remove Paymob credentials
        DELETE
      • Save Kashier credentials
        PUT
      • Get Kashier credentials status
        GET
      • Remove Kashier credentials
        DELETE
      • Save Fawaterak credentials
        PUT
      • Get Fawaterak credentials status
        GET
      • Remove Fawaterak credentials
        DELETE
      • Save Moyasar credentials
        PUT
      • Get Moyasar credentials status
        GET
      • Remove Moyasar credentials
        DELETE
      • Get shipping settings
        GET
      • Update shipping settings
        PATCH
      • Add shipping zone
        POST
      • Update shipping zone
        PATCH
      • Delete shipping zone
        DELETE
      • Save Bosta credentials
        PUT
      • Get Bosta credentials status
        GET
      • Remove Bosta credentials
        DELETE
      • Get invoice/tax settings
        GET
      • Update invoice/tax settings
        PATCH
      • Get WhatsApp settings
        GET
      • Update WhatsApp settings
        PATCH
      • Get storefront customization settings
        GET
      • Update storefront customization (save draft)
        PATCH
      • Publish storefront customization to live store
        POST
      • Reset storefront customization to theme defaults
        POST
      • Upload a customization asset (logo, favicon, hero image)
        POST
      • List customization assets
        GET
      • Update an asset's alt text / display name
        PATCH
      • Delete a customization asset
        DELETE
      • Get checkout fields config
        GET
      • Update checkout fields config
        PUT
      • Save InstaPay credentials
        PUT
      • Get InstaPay credentials status
        GET
      • Remove InstaPay credentials
        DELETE
      • Save Vodafone Cash credentials
        PUT
      • Get Vodafone Cash credentials status
        GET
      • Remove Vodafone Cash credentials
        DELETE
      • Save WE Pay credentials
        PUT
      • Get WE Pay credentials status
        GET
      • Remove WE Pay credentials
        DELETE
      • Save Orange Cash credentials
        PUT
      • Get Orange Cash credentials status
        GET
      • Remove Orange Cash credentials
        DELETE
      • Upload merchant-generated InstaPay QR image
        POST
      • Remove the uploaded InstaPay QR image
        DELETE
      • Get all tracking settings
        GET
      • Get the tracking-credential validation contract
        GET
      • Save Meta Pixel + CAPI settings
        PUT
      • Disconnect Meta tracking
        DELETE
      • Send a synthetic Purchase test event to Meta
        POST
      • Get recent Meta CAPI events
        GET
      • Verify the Meta Pixel against Meta
        POST
      • Get Meta Event Match Quality
        GET
      • Get Meta tracking status
        GET
      • Save TikTok Pixel + Events API settings
        PUT
      • Disconnect TikTok tracking
        DELETE
      • Send a synthetic Purchase test event to TikTok
        POST
      • Get recent TikTok Events API events
        GET
      • Get TikTok Events API deliveries that failed
        GET
      • Re-send failed TikTok Events API deliveries
        POST
      • Verify the TikTok Pixel against TikTok
        POST
      • Get TikTok tracking status
        GET
      • Get TikTok Marketing ad-performance report
        GET
      • Connect TikTok Shop (persist token + shop)
        PUT
      • TikTok Shop connection status
        GET
      • Disconnect TikTok Shop
        DELETE
      • Get onboarding progress
        GET
      • Complete an onboarding step
        POST
      • Skip an onboarding step
        POST
      • Dismiss onboarding
        POST
      • Restore dismissed onboarding
        POST
      • Auto-configure store from wizard answers
        POST
      • List reconciliation runs
        GET
      • Get mismatches for a reconciliation run
        GET
      • Resolve or reopen a reconciliation mismatch
        PATCH
      • Trigger reconciliation for a date
        POST
      • Payment volume broken down by gateway
        GET
      • List shipping zones
        GET
      • Create a shipping zone
        POST
      • Get a shipping zone
        GET
      • Update a shipping zone
        PATCH
      • Deactivate (soft-delete) a shipping zone
        DELETE
      • Create a rate on a zone
        POST
      • Update a rate
        PATCH
      • Deactivate a rate
        DELETE
      • Return covered/uncovered governorates for the store
        GET
      • Apply the Quick Start: Egypt 4-zone preset
        POST
      • Preview rates for a cart (merchant calculator tool)
        POST
      • Get Balances
        GET
      • List Transactions
        GET
      • List Invoices
        GET
      • List installable apps
        GET
      • List installs for this store
        GET
      • Install an app
        POST
      • Update app settings
        PUT
      • Disable app
        POST
      • Enable app
        POST
      • Uninstall app
        DELETE
      • Void a payment the merchant recorded by hand
        POST
      • Print the invoice for an order, paid or not
        GET
      • Signed link to a Partner App's own admin
        GET
      • The store's subscription to a paid app
        GET
      • Pay for a paid app from the store's wallet
        POST
      • Cancel a paid app at the end of the paid period
        DELETE
      • Re-send failed Meta Conversions API deliveries
        POST
    • Analytics
      • Get dashboard statistics
      • Get revenue chart data
      • Get top selling products (dashboard)
      • Get daily order streak
      • Get sales overview
      • Get sales chart data
      • Get top selling products (analytics)
      • Get sales by location
      • Get customer analytics
      • Get conversion statistics
      • Get orders by traffic source
      • Get COD rejection statistics
      • Get merchant health score
      • Get orders breakdown analytics
      • Get revenue breakdown analytics
      • Get customer RFM segmentation
      • Get inventory analytics (sell-through, ABC, dead stock)
      • Get product performance analytics
      • Get top storefront search terms
      • Customer health scores + states
      • Statistical predictions (stockouts, bands, repeat, COD)
      • Get active advisor signals
      • Dismiss an advisor signal
      • Re-run the advisor rules for this store now
      • Executive dashboard — what should I do today?
      • Anonymous peer benchmarks (k-anonymity gated)
      • Custom report: metrics grouped by a chosen dimension
      • Get weekly-digest preferences
      • Set weekly-digest preferences
      • Preview the weekly analytics digest
      • Get store-event annotations for charts
      • Get metric targets with live pace
      • Set metric targets
      • Get conversion funnel
      • Get marketing attribution analytics
      • Get customer LTV by first-touch acquisition channel
      • Get AI-powered store insights
      • Get sales forecast
      • Get customer sessions list
      • Get session detail timeline
      • Multi-touch attribution per channel + campaign
      • Get real-time analytics snapshot
      • Today's orders by location (governorate)
      • SSE stream for real-time analytics
    • Customers
      • Preview a CSV customer import (parses headers + suggests mapping)
      • Execute a CSV customer import with a confirmed mapping
      • List the target fields the customer importer understands
      • List store customers
      • Create a customer manually
      • Get customer by ID
      • Get customer COD trust network stats
      • Erase a customer's analytics footprint (DSAR)
      • Get a customer's full touchpoint journey
      • Conversations linked to this customer
      • Adopt a linked conversation's profile picture as the customer photo
    • Marketing
      • Create new coupon
      • List coupons
      • Get coupon by ID
      • Update coupon
      • Delete coupon
      • Bulk-update promotion priorities (drag-to-reorder)
      • Issue a short-lived preview token for the builder iframe
      • List promotions for a store
      • Create a new promotion
      • Get a single promotion by id
      • Update a promotion (optimistic lock via `version`)
      • Soft-delete (archive) a promotion
      • Duplicate a promotion as a new draft
      • Move a promotion to ACTIVE
      • Move a promotion to PAUSED
      • Move a promotion to ARCHIVED
      • Aggregate analytics for one promotion within a date range
      • List social connections
      • Connect social account
      • Disconnect social account
      • Fetch posts from connected account
      • Import social posts as draft products
      • Import products from Instagram/Facebook post URLs
      • Get Meta Embedded Signup config
      • Complete WhatsApp embedded signup
      • Disconnect WhatsApp Business
      • Get WhatsApp connection status
      • Get WhatsApp notification settings
      • Update WhatsApp notification settings
      • Get WhatsApp analytics
      • List recent WhatsApp messages
      • Connect merchant's own Meta WABA (BYO)
      • Disconnect BYO Meta WABA and revert to platform-managed
      • Get WhatsApp connection status (BYO-aware)
      • Update store-level WhatsApp preferences (e.g. message language)
      • Update notification toggles (BYO-path)
      • Get the store's WhatsApp access-gate state
      • Open (or resume) the bill for this store's WhatsApp access
      • Request WhatsApp access for this store (merchant)
      • List WhatsApp templates
      • Create WhatsApp template
      • Delete WhatsApp template
      • Sync template statuses from Meta
      • List registered email events
      • Get registry default template for an event/language
      • List merchant email templates
      • Create email template override
      • Get email template by ID
      • Update email template
      • Delete email template
      • Preview an unsaved email-template draft
      • Preview a saved email template
      • Send a test email rendered from this template
      • List conversations (inbox)
      • Get unread conversation count
      • Get messages for a conversation
      • Send a message in a conversation
      • Update conversation (mark read, archive, assign)
      • List campaigns
      • Create campaign draft
      • Get campaign details
      • Update campaign draft
      • Send campaign now
      • Schedule campaign
      • Cancel scheduled campaign
      • List campaign recipients
      • Estimate audience size
      • List Opt Ins
      • Create Opt In
      • Revoke Opt In
      • List Scheduled Sends
      • Create Scheduled Send
      • Get Scheduled Send
      • Cancel Scheduled Send
      • List Dead Letters
      • Get Dead Letter
      • Replay Dead Letter
      • Connect Meta
      • Meta Callback
      • Connect Assets
      • Sync History
      • Disconnect Channel
      • List Connections
      • List Threads
      • Get Thread
      • Mark Read
      • Resolve Thread
      • Link Customer
      • Unlink Customer
      • List Messages
      • Send Message
      • Create Template
      • List Templates
    • Online store
      • List menus
      • Create menu
      • Get menu by handle
      • Update (or create) a menu by handle
      • Delete menu
      • List pages
      • Create page
      • Get page by handle
      • Update (or create) a page by handle
      • Delete page
      • List all themes available to a store (built-in + external)
      • Submit External Theme
      • Get External Theme Info
      • Remove External Theme
      • Connect a local theme dev server (numu-theme dev)
      • Get Build Status
      • Rebuild External Theme
      • Validate External Theme
      • List all theme installations for a store
      • Install a theme on the store
      • Get a specific installation
      • Rename a theme installation
      • Uninstall a theme from the store
      • Duplicate a theme installation into a new draft copy
      • Export an installation as a portable JSON document
      • Activate an installed theme
      • Save draft customization (not yet live)
      • Publish draft customization (goes live)
      • Generate a preview URL for an installation
      • List the store's theme workspace files
      • Read one workspace file
      • Create or overwrite a workspace file
      • Delete a workspace file
      • Seed a buildable starter theme into the workspace
      • Build & publish the code-editor workspace
      • Get Draft
      • Autosave Draft
      • Publish
      • List Versions
      • Get Version Payload
      • Restore Version
      • Discard Draft
      • Get Schemas
      • Resolve Theme
      • List undo entries
      • Append an undo entry
      • Clear undo stack
      • Remove an undo entry (after applying)
    • OAuth
      • Token
      • Revoke
  1. Settings & money

Save TikTok Pixel + Events API settings

PUT
https://numueg.app/api/v1/stores/{store_id}/settings/tracking/tiktok
Last modified:2026-09-19 16:39:33
x-numu-scope:settings:write
Upsert the per-store TikTok tracking config and (optional) API token.
422 if api_enabled = true and no token is on file AND none is
supplied in the body.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Successful Response
Bodyapplication/json

🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://numueg.app/api/v1/stores//settings/tracking/tiktok' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "pixel_id": "string",
    "pixel_enabled": true,
    "api_enabled": true,
    "api_access_token": "stringstri",
    "test_event_code": "string",
    "consent_required": false,
    "debug_mode": false,
    "purchase_trigger": "confirmed",
    "pixels": [
        {
            "pixel_id": "string",
            "pixel_enabled": true,
            "api_enabled": true,
            "label": "string",
            "role": "primary"
        }
    ],
    "advertiser_id": "string",
    "offline_event_set_id": "string"
}'
Response Response Example
200 - Example 1
{
    "success": true,
    "data": {
        "pixel_id": "string",
        "pixel_enabled": false,
        "api_enabled": false,
        "mode": "off",
        "api_access_token_masked": "string",
        "has_token": false,
        "test_event_code": "string",
        "consent_required": false,
        "debug_mode": false,
        "debug_mode_expires_at": "2019-08-24T14:15:22.123Z",
        "last_validated_at": "2019-08-24T14:15:22.123Z",
        "status": "disabled",
        "purchase_trigger": "confirmed",
        "pixels": [
            {
                "pixel_id": "string",
                "pixel_enabled": true,
                "api_enabled": true,
                "label": "string",
                "role": "primary"
            }
        ],
        "advertiser_id": "string",
        "offline_event_set_id": "string"
    },
    "message": "string"
}
Modified at 2026-09-19 16:39:33
Previous
Get Meta tracking status
Next
Disconnect TikTok tracking
Built with