LogoLogo
CtrlK
HomeDocumentationLog InSign Up
  • 📣Welcome!
  • ☑️Quick Start
  • ✔️Terms, Definitions, Abbreviations & Regulations
    • Terms
    • Definitions
      • ✔️Entity
      • ✔️Entity Class
      • ✔️Memory Class
      • ✔️Authentication Key
    • Abbreviations
    • Regulations
  • 🚩Essentials
    • ✔️Entity Classes
      • ✔️Brand
      • ✔️User
        • ✔️Password
        • ✔️Username
        • ✔️Accounts
        • ✔️Referral
        • ✔️User Notification
        • ✔️Usage
      • ✔️Device
      • ✔️Plans & Pricing
        • ✔️License
          • ✔️Usage
        • ✔️Package
        • ✔️Feature
        • ✔️Configuration
        • ✔️Price
        • ✔️Coupon
      • ✔️Payment-Related
        • ✔️Payment
        • ✔️Payment History
        • ✔️Payment Method
        • ✔️Wallet
      • ✔️Point-Related
        • ✔️Point
        • ✔️Point Event
        • ✔️Point History
        • ✔️Point Reward
      • ✔️Role-Based Access Control (RBAC)
        • ✔️Role
        • ✔️Permission
      • ✔️Tracking-Related
        • ✔️Tracking event
        • ✔️Tracking activity
        • ✔️Tracking email
        • ✔️Email pattern
        • ✔️Helpdesk
      • ✔️System Configuration
        • ✔️SMTP Setting
        • ✔️Blacklist
        • ✔️Configuration
        • ✔️External authentication provider
        • ✔️Payment Provider
      • ✔️System Definition
        • ✔️Country
        • ✔️State
        • ✔️City
        • ✔️Currency
        • ✔️Language
        • ✔️Time Zone
    • ✔️Memory Classes
      • ✔️Event Class
      • ✔️Token Service Class
      • ✔️Error Manager
      • ✔️Session Manager
      • ✔️Version
      • ✔️Mail Service
      • ✔️CDN Service
    • ✅Third-party APIs
      • Webhooks
  • 🎯Guide
    • ✔️Login with Google
    • Integrate i18n
    • Integrate reCAPTCHA
  • References
    • Design Specifications
      • System Definitions
        • Country
        • State
        • City
        • Time Zone
        • Currency
        • Language
      • System Configurations
        • Configuration
        • External Login Provider
        • Payment Provider
        • BlackList
        • CDN
        • Address
      • Soft Deletion
        • Brand
          • Brand Email
          • Brand Link
          • Brand Profile
          • Brand Setting
        • User
          • User Profile
          • User Setting
        • Device
          • Device Profile
      • Role-Based Access Control
        • Role
        • Permission
      • Plans & Pricing
        • Feature
        • License
        • configuration
        • Package
        • Coupon
        • Price
      • Payment-Related
        • Payment
        • Payment Method
        • Payment History
        • Wallet
      • Point-Related
        • Point
        • Point Event
        • Point History
      • Tracking-Related
        • Tracking Activity
        • Tracking Event
        • Tracking Email
        • Tracking Email Pattern
        • Tracking Email Read
        • Helpdesk
        • Helpdesk Feedback
      • Relationships
        • Coupon - User
        • External Login Provider - User
        • Package - Feature
        • Role - Permission
    • ✔️JFW API
      • Overview
      • Authentication
      • Rate Limiting
      • Errors
      • API Reference
        • Ads
          • Activate an ad
          • Creates an ad
          • Deactivate an ad
          • Deletes an ad
          • Gets ads client view
          • Gets ads
          • Gets an ad
          • Updates an ad
        • Analytics
          • Devices
          • Issues
          • Users
          • Payments
        • App Integrations
          • Get apps integration
          • Analytics
            • Creates an app integration analytics
            • Deletes an app integration analytics
            • Gets an app integration analytics
            • Get apps integration analytics with brand
            • Updates an app integration analytics
          • Authentication
            • Creates an app integration authentication
            • Creates an app integration authentication with import file settings
            • Deletes an app integration authentication
            • Gets an app integration authentication
            • Get apps integration authentication with brand
            • Test building an authentication URL
            • Updates an app integration authentication
          • Payment Gateway
            • Creates an app integration payment gateway
            • Delete an app integration payment gateway
            • Get an app integration payment gateway
            • Get apps integration payment gateway with brand
            • Test creating a checkout link
            • Update an app integration payment gateway
          • Push Notification
            • Creates an app integration push notification
            • Creates an app integration push notification with import file settings
            • Delete an app integration push notification
            • Get an app integration push notification
            • Get an app integration push notification with brand
            • Update an app integration push notification
          • Recaptcha
            • Creates an app integration recaptcha
            • Deletes an app integration recaptcha
            • Gets an app integration recaptcha
            • Get apps integration recaptcha with brand
            • Updates an app integration recaptcha
          • SMS
            • Creates an app integration SMS
            • Delete an app integration SMS
            • Get an app integration SMS
            • Get apps integration SMS with brand
            • Test sending an SMS message
            • Update an app integration SMS
          • SMTP
            • Creates an app integration SMTP
            • Delete an app integration SMTP
            • Get an app integration SMTP
            • Get apps integration SMTP with brand
            • Test sending an email message
            • Update an app integration SMTP
        • Brands
          • Check domain if exists
          • Create a brand
          • Generate a new domain
          • Get a brand
          • Get a brand by url
          • Get brands
          • Update a brand
          • Get emails with a brand
          • Update a brand's profile
          • Update a brand's setting
          • Email Address
            • Create an email address
            • Delete an email address
            • Get an email address
            • Get email addresses
            • Update an email address
        • CDN
          • Delete a file CDN
          • Get a file CDN
          • Get files CDN
          • Upload a file CDN
        • Cities
        • Commission rate
          • Creates a commission rate
          • Deletes a commission rate
          • Gets a commission rate
          • Gets discount value
          • Get commission rates
          • Updates a commission rate
        • Configurations
          • Create a configuration
          • Delete a configuration
          • Get configurations
          • Get a configuration
          • Update a configuration
        • Constants
          • Brand Link
          • Black List
          • Coupon
          • Commission Rate
          • Device
          • Invoice
          • Issue
          • License
          • Organization
          • Payment
          • Transaction
          • Tracking Event
          • Tracking Notification
          • Feature
          • User
          • Wallet
          • Error
        • Coupons
          • Create a Coupon
          • Delete a Coupon
          • Get a Coupon
          • Get Coupons
          • Update a Coupon
        • Cryptographies
          • Decrypt
          • Encrypt
        • Countries
        • Currencies
        • Devices
          • Checks user access device
          • Create a device
          • Delete a device
          • Get a device by code
          • Get a device
          • Get current device of the user authorized
          • Get devices by list code
          • Get devices
          • Get users from a device id
          • Get users from a device code
          • Refresh device token
          • Statistics devices
          • Update a device
        • Domains
          • Delete a domain
          • Get domains
          • Get a domain
          • Brand links
            • Create a brand link
            • Delete a brand link
            • Get a brand link
            • Get brand links by type
            • Get brand links
            • Update a brand link
        • Events
          • Get an event
          • Get email template default by event
          • Get an email template by event
          • Get events
          • Get events earning wallet
          • Get events that are associated with email templates
          • Get events that are associated with phone templates
          • Get phone template by event
          • Get phone template default by event
        • Exchange rates
          • Get exchange rates
          • Convert currency
        • Email Template
          • Create an email template
          • Delete an email template
          • Get an email template
          • Get email templates
          • Gets all placeholder keys available
          • Update an email template
        • Features
          • Add packages to a feature
          • Create a feature
          • Delete a feature
          • Get a feature
          • Get features
          • Get packages from a feature
          • Remove packages from a feature
          • Update a feature
        • Invoices
          • Delete an invoice
          • Get invoices
          • Get an invoice
          • Download an invoice
        • Issue categories
          • Create an issue category
          • Delete an issue category
          • Get issue categories
          • Get an issue category by code
          • Get an issue category by id
          • Update an issue category
        • Issues
          • Create an issue
          • Delete an issue
          • Get issues
          • Get an issue
          • Get issues by list id
          • Get children issues
          • Update an issue
          • Issue Reaction
            • Create an issue reaction
            • Delete an issue reaction
        • Languages
        • Licenses
          • Activate a license
          • Applies a license to the logged user
          • Applies a license to the given login name
          • Applies a license to the given a user
          • Checks a license code
          • Create the licenses
          • Count licenses created
          • Deactivate a license
          • Delete a license
          • Get licenses
          • Get a license
          • Generate license code
          • Purchase to add licenses by checkout link
          • Purchase to add licenses by wallet
          • Statistics licenses monthly
          • Updates a license
        • MFA
          • Get a list of MFA
        • Organizations
          • Adds a new user to the organization
          • Adds a user for default language code organization system
          • Assign role for a user in an organization
          • Creates an organization
          • Deletes an organization
          • Get an organization
          • Get organizations
          • Get users of an organization
          • Remove a user in an organization
          • Updates an organization
          • Updates users status in an organization
        • Notifications
          • Create a broadcast
          • Get a notification
          • Get notifications
          • Push notification message for tokens
          • Push notification data message by tokens
          • Test push notification data message
        • Packages
          • Add features to a package
          • Calculate total price checkout
          • Create a package
          • Delete a package
          • Get a package
          • Get features from a package
          • Get packages
          • Get prices from a package
          • Remove features from a package
          • Renewal or upgrade user's package
          • Update a package
          • Update package feature data
        • Payments
          • Generate checkout link to pay payment
          • Get a payment
          • Get payments
          • Gets the overview Sell Dashboar
        • Permissions
          • Add roles to a permission
          • Create a permission
          • Delete a permission
          • Get a permission
          • Get permissions
          • Get roles from a permission
          • Remove roles from a permission
          • Update a permission
        • Prices
          • Create a price
          • Delete a price
          • Generate checkout link
          • Get a price
          • Get prices
          • Update a price
        • Resource types
          • Create a resource type
          • Delete a resource type
          • Get a resource type
          • Get resource types
          • Update a resource type
        • Roles
          • Assign users to a role
          • Delete a role
          • Create a role
          • Get a role
          • Get roles
          • Grants permissions to a role
          • Get permissions granted by role
          • Remove permissions from a role
          • Update a role
        • States
        • Subscription types
          • Create a subscription type
          • Delete a subscription type
          • Get a subscription type
          • Get prices from a subscription type
          • Get subscription types
          • Update a subscription type
        • Time zones
        • Tracking Activities
          • Get activities
          • Get a activity
        • Tracking emails
          • Get a tracking email
          • Get tracking emails
        • Users
          • Activate a user
          • Add a device to a user
          • Applies the referral code to a user
          • Assigns roles to a user
          • Authentication by Apple
          • Authentication by Google
          • Authentication by phone number
          • Authentication
          • Change password
          • Change password for another user
          • Check referral user code
          • Check AuthKey available
          • Configurations
          • Deactivate a user
          • Delete a user
          • Email address verification
          • Forgot password
          • Get a user by username
          • Get a user
          • Get app integration authenticate URLs
          • Get devices from a user
          • Get identities from a user
          • Get users by list ids
          • Get users
          • Gets roles assigned to the user
          • Gets the current user logged in
          • Gets the referees of a user
          • List all the brand partners authenticate
          • Lock a user
          • Refresh auth key
          • Register a new user
          • Register a new user by email
          • Register a new user by phone
          • Remove a device from a user
          • Reset password
          • Revokes roles from the user
          • Statistics users
          • Suspend a user
          • Unlock a user
          • Unsuspend a user
          • Update a user
          • Update user type
          • Update user device
          • Update device data related to an authorized user
          • Notification
            • Get a notification related to a user
            • Get notifications by the user's id
            • Mark a notification as read
            • Mark all notifications read
          • Passwordless
            • Email
              • Authentication by email magic link
              • Generate email OTP code
              • Verify email address OTP code to authentication
            • Phone
              • Generate SMS OTP code
              • Verify SMS OTP code to authentication
            • QR code
              • Generate a new QR code
              • Get the current status of a QR code
              • Approve a QR code
              • Log in using an approved QR code
              • Auth with an approved QR code
            • OTP code
              • Generate a new OTP code
              • Get the current status of a OTP code
              • Approve a OTP code
              • Log in using an approved OTP code
              • Auth with an approved OTP code
        • Wallets
          • Add money to a Wallet with checkout link
          • Apply redeem code
          • Create a wallet default
          • Convert wallet money
          • Close wallet
          • Get wallets
          • Get the wallet histories
      • Libraries
        • Javascript
        • Dot Net
        • Flutter
  • ☑️Change logs
  • ❔Questions & Feedback
  • References
Powered by GitBook
On this page

Was this helpful?

  1. References
  2. ✔️JFW API
  3. API Reference

Ads

Activate an adCreates an adDeactivate an adDeletes an adGets ads client viewGets adsGets an adUpdates an ad
PreviousAPI ReferenceNextActivate an ad

Last updated 16 days ago

Was this helpful?