Daftra API
All Endpoints
Daftra PartnersDevelopers Portal
All Endpoints
Daftra PartnersDevelopers Portal
  1. Developers Portal Endpoints
  • Welcome
  • Getting Started
  • Authorization
    • How To Authorize
    • Generate Access Token
      POST
  • Endpoints
    • Site
      • GET Site Info
    • Sales
      • Invoices
        • GET All Invoices
        • GET Single Invoice
        • Edit Invoices
        • Delete Invoices
        • Add New Invoice
        • Bulk Add Invoices
        • Update Invoice Draft Status
        • Assign Work Order to Invoice
        • Add Shipping to Invoice
        • Convert Sales Order to Invoice
        • Delete Sales Order
      • Subsciptions
        • List Subscriptions
        • View Subscription
        • Create Subscription
        • Edit Subscription
        • Delete Subscription
      • Estimates
        • GET All Estimates
        • GET Single Estimate
        • Add New Estimate
        • Edit Estimates
        • Delete Estimates
      • Credit Notes
        • GET All Credit Notes
        • GET Single Credit Note
        • Add New Credit Note
        • Edit Credit Notes
        • Delete Credit Notes
      • Refund Receipts
        • GET All Refund Receipts
        • GET Single Refund Receipt
        • Add New Refund Receipt
        • Edit Refund Receipts
        • Delete Refund Receipts
        • Bulk Add Refund Receipts
      • Invoice Payments
        • GET All Invoice Payments
        • GET Single Invoice Payment
        • Add New Invoice Payment
        • Edit Invoice Payments
        • Delete Invoice Payments
      • Invoice Appointments
        • GET All Invoice Appointments
        • GET Single Invoice Appointment
        • Add New Invoice Appointment
        • Edit Invoice Appointments
        • Delete Invoice Appointments
      • Advance Payment Invoices
        • GET All Advance payment
        • GET Single Advance payment
        • Add Advance Payment
      • Estimate Appointments
        • GET All Estimate Appointments
        • GET Single Estimate Appointment
        • Add New Estimate Appointment
        • Edit Estimate Appointments
        • Delete Estimate Appointments
        • Update Estimate Appointment (POST alias)
      • Shipping Options
        • List Shipping Options
      • POS
        • Get POS Shift Session
      • Follow-Up Status
        • Get All Follow-Up Statuses by type
        • Get Single Follow-Up Status
        • Delete Follow-Up Status
        • Get All Follow-Up Statuses
        • Add New Follow-Up Status
    • Clients
      • Clients
        • GET All Clients
        • GET Single Client
        • Add New Client
        • Edit Clients
        • Delete Clients
        • Assign Staff To Client
        • Client Loyalty Points
        • Bulk Add Clients
        • Client Has Membership
        • Client Attendance By Barcode
      • Client Appointments
        • GET All Client Appointments
        • GET Single Client Appointment
        • Add New Client Appointment
        • Edit Client Appointments
        • Delete Client Appointments
      • Client Payments
        • GET All Client Payments
        • GET Single Client Payment
        • Add New Client Payment
        • Edit Client Payments
        • Delete Client Payments
      • Client Attendance Log
        • Get All Client Attendance Logs
        • Get Single Client Attendance Log
        • Add New Client Attendance Log
        • Edit Client Attendance Log
        • Delete Client Attendance Log
      • Notes
        • GET All Notes
        • GET Single Note
        • Add New Note
        • Edit Notes
        • Delete Notes
      • Follow-Up Action
        • Get All Follow-Up Actions
        • Get Single Follow-Up Action
        • Delete Follow-Up Action
    • Bookings
      • Booking (Classic version)
        • Get All Bookings
        • Get Single Booking
        • Add new Booking
        • Delete booking
        • Change Booking Status
        • Convert booking to Invoice
      • Booking (Beta version)
        • Get All Bookings
        • Get Single Booking
        • Add new Booking
        • Delete booking
        • Change Booking Status
    • Work Orders
      • Work Order Appointments
        • GET All Work Order Appointments
        • GET Single Work Order Appointment
        • Add New Work Order Appointment
        • Edit Work Order Appointments
        • Delete Work Order Appointments
        • Update Work Order Appointment (POST alias)
      • Work Orders
        • GET All Work Orders
        • GET Single Work Order
        • Add New Work Order
        • Edit Work Orders
        • Delete Work Orders
    • Inventory
      • Products
        • GET All Products
        • GET Single Product
        • Add New Product
        • Edit Products
        • Delete Products
        • List Brands
      • Requsitions
        • GET All Requisitions
        • GET single Requisition
        • Add New Requisition
        • Edit Requisitions
        • Delete Requisitions
        • Trigger Requisition Update
      • Product Categories
        • GET All Product Categories
        • GET Single Product Category
        • Add New Product Category
        • Edit Product Category
        • Delete Product Category
        • Update Category Display Order
        • Update Category Items
      • Stores
        • GET All Stores
        • GET Single Store
        • Add New Store
        • Edit Stores
        • Delete Stores
      • Stock Transactions
        • GET All Stock Transactions
        • GET Single Stock Transaction
        • Add New Stock Transaction
        • Edit Stock Transactions
        • Delete Stock Transactions
      • Product Bundles
        • Add Product bundle
      • Brands
        • Get All Brands
        • Get Single Brand
        • Add New Brand
        • Edit brand
      • Unit Templates
        • Get All Unit Templates
        • Get Single Unit Template
        • Add Unit Template
        • Edit Unit Template
    • Accounting
      • Journal Cats
        • GET All Journal Cats
        • GET Single Journal Cat
        • Add New Journal Cat
        • Edit Journal Cats
        • Delete Journal Cats
      • Journal Accounts
        • GET All Journal Accounts
        • GET Single Journal Account
        • Add New Journal Account
        • Edit Journal Accounts
        • Delete Journal Accounts
      • Journals
        • GET All Journals
        • GET Single Journal
        • Edit Journals
        • Delete Journals
        • Add New Journal
      • Cost Centers
        • Get All Cost Centers
        • Get Single Cost Center
        • Add New Cost Center
        • Edit Cost Center
        • Delete Cost Center
    • Finance
      • Expenses
        • GET All Expenses
        • GET Single Expens
        • Add New Expens
        • Edit Expenses
        • Delete Expenses
      • Treasuries
        • GET All Treasuries
        • GET Single Treasury
        • Add New Treasury
        • Edit Treasuries
        • Delete Treasuries
      • Incomes
        • GET All Incomes
        • GET Single Income
        • Add New Income
        • Edit Incomes
        • Delete Incomes
    • Taxes
      • GET All Taxes
      • GET Single Taxe
      • Add New Taxe
      • Edit Taxes
      • Delete Taxes
    • Purchases
      • Purchase Refunds
        • GET All Purchase Refunds
        • GET Single Purchase Refund
        • Add New Purchase Refund
        • Edit Purchase Refunds
        • Delete Purchase Refunds
      • Purchase Invoices
        • GET All Purchase Invoices
        • GET Single Purchase Invoice
        • Add New Purchase Invoice
        • Edit Purchase Invoices
        • Delete Purchase Invoices
      • Purchase Orders
        • GET All Purchase Orders
        • GET Single Purchase Order
        • Add New Purchase Order
        • Edit Purchase Order
        • Delete Purchase Order
      • Purchase Debit Note
        • Purchase Debit Note
        • Purchase Debit Note
    • Suppliers
      • GET All Suppliers
      • GET Single Supplier
      • Add New Supplier
      • Edit Suppliers
      • Delete Suppliers
    • Staff
      • GET Single Staff
      • GET All Staff
    • Time Tracking
      • GET All Time Tracking
      • GET Single Time Tracking
      • Edit Time Tracking
      • Delete Time Tracking
      • Add New Time Tracking
    • General Listing
      • GET General Listing
    • HR
      • Leave Application
        • Get Single Leave Applications
        • Add Leave Application
        • Edit Leave Application
        • Get All Leave Applications
      • Attendance Logs
        • Get All Attendance Logs
        • Get Single Attendance Log
        • Add Attendance Log
      • Employee Asset
        • Asset Type
          • Get All Types
          • Get Single Type
          • Add New Type
          • Edit Type
        • Asset Location
          • Get All Locations
          • Get Single Location
          • Add New Location
          • Edit Location
        • Asset Storage
          • Get All Storages
          • Get Single Storage
          • Add New Storage
          • Edit Storage
        • Asset
          • Get All Assets
          • Get Single Asset
          • Add New Asset
          • Edit Asset
      • Organizational Structure
        • Designation
          • Get All Designations
          • Get Single Designation
          • Add New Designation
          • Edit Designation
        • Department
          • Get All Departments
          • Get Single Department
          • Add New Department
          • Edit Department
        • Employment Type
          • Get All Employment Types
          • Get Single Employment Type
          • Add New Employment Type
          • Edit Employment Type
    • Branches
      • Get All Branches
      • Get Single Branch
      • Add New Branch
      • Edit Branch
      • Delete Branch
    • Payment Gateways
      • Get All Payment Methods
      • Get Single Payment Method
      • Add Payment Method
    • Points & Credits
      • Credit Usage
        • Get All Credit Usage
        • Get Single Credit Usage
        • Add New Credit Usage
        • Add Credit Usage Amount
        • Edit Credit Usage
        • Edit Credit Usage Amount
        • Get All Credit Usage Amount
        • Get Single Credit Usage Amount
      • Credit Types
        • Get All Credit types
        • Get Single Credit type
        • Add New Credit type
        • Edit Credit type
      • Credit Charges
        • Get All Credit Charges
        • Get Single Credit Charge
        • Add New Credit Charge
        • Edit Credit Charge
      • Packages
        • Get All Packages
        • Get Single Package
        • Add New Package
        • Edit Package
      • Packages Credit Types
        • Get All Package Credit Types
        • Get Single Package Credit Type
        • Add Package Credit Type
        • Edit Package Credit Type
    • Workflow
      • Get All Records
      • Get Single Record
      • Add New Record
      • Edit Record
    • Multity entity request
      • Overview
      • Multy Entity Request
    • Entities
      • List entity records
      • View entity record
      • Create entity record
      • Update entity record
      • Delete entity record
  • Advanced Filtering
    • API Improvements
    • Filtering
    • Endpoints Structure
    • Using API v2
      • Data Fetching — Filtered
  • Developers Portal
    • Introduction & Getting Started
    • Dashboard, Earnings & Withdrawals
    • Creating a New App
    • App Configuration
    • Managing Your App
    • Entities: Modeling Your Data
    • The Entity Builder
    • Buttons & Page Scripts
    • Integrations: Webhooks
    • Invitations, Publishing & Reviews
    • Developers Portal Endpoints
      • Activate / Deactivate App
        GET
      • Lock / Unlock Entity Record
        GET
      • Check App Status
        GET
  1. Developers Portal Endpoints

Lock / Unlock Entity Record

Production
https://{{subdomain}}.daftara.com
Production
https://{{subdomain}}.daftara.com
GET
https://{{subdomain}}.daftara.com
/v2/api/apps-manager/{appId}/{entityKey}/{entityId}/{lock}
Locks or unlocks an entity record on behalf of an installed app.
Intended for third-party app integrations: an installed app can lock a specific record of any entity it has access to (preventing further edits) or unlock it again. Send true in the lock path segment to lock the record; any other value unlocks it.
Authenticated with an OAuth bearer token. The response is always HTTP 200 with a { status, msg } object — inspect status to tell success from the two failure cases (the app is not installed/active for the site, or the record was not found).

Request

Path Params

Header Params

Responses

🟢200Success
application/json
Lock/unlock outcome. Example bodies:
Locked:
{ "status": true, "msg": "Record locked successfully" }
Unlocked:
{ "status": true, "msg": "Record unlocked successfully" }
App not installed/inactive (still HTTP 200):
{ "status": false, "msg": "App is not installed or inactive" }
Record not found (still HTTP 200):
{ "status": false, "msg": "Record not found" }
Bodyapplication/json

🟠401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https://.daftara.com/v2/api/apps-manager/123/product/456/true' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json'
Response Response Example
200 - Example 1
{
    "status": true,
    "msg": "Record locked successfully"
}
Previous
Activate / Deactivate App
Next
Check App Status