Resources and methods in the Omnifox SDKs

The 25 resources the Node and Python SDKs expose, with the methods of each one and the naming differences between the two languages.

Aug 19, 2026

Watch this step in the video · Official SDKs: Node, Python and PHP

Both SDKs organize the API into 25 resources hanging off the client. The main difference is style: Node uses camelCase and Python uses snake_case.

Inbox

Resource Node Python
Contacts contacts contacts
Conversations conversations conversations
Messages messages messages
Channels channels channels
Broadcasts broadcasts broadcasts
Tags tags tags
Quick replies snippets snippets
Custom fields customFields custom_fields

Contacts. list, get, search, create, upsert, update, delete, merge, channels, attachTag/attach_tag, detachTag/detach_tag, attachTagsByName/attach_tags_by_name, detachTagsByName/detach_tags_by_name, openConversation/open_conversation, closeConversation/close_conversation, assignConversation/assign_conversation, setConversationStatus/set_conversation_status, comment. Node adds listPage, listViaDsl, sendMessage, listMessages, and getMessage; Python uses list_filtered and leaves messages in client.messages.

Conversations. list, get, create, assign, close, reopen, addNote/add_note, windowStatus/window_status. Node also has listMessages, sendMessage, getMessage, and listPage.

Messages. In Node, only send. In Python, send, list, and get.

Channels. list, get, disconnect, health, templates, plus create in Node and connect in Python (the name changes).

CRM

Resource Node Python
Companies companies companies
Deals deals deals
Pipelines pipelines pipelines
Activities crmActivities crm_activities

Deals. list, get, create, update, delete, moveToStage/move_to_stage, close, timeline, board, bulk. The bulk operation acts on up to 500 deals (reassign, move_stage, close, delete).

Pipelines. list, get, create, update, delete, createStage/create_stage, updateStage/update_stage, deleteStage/delete_stage.

The whole CRM has a double lock: the plan needs the CRM enabled and the token needs read:crm or write:crm. If either one is missing, the answer is 403.

Projects and boards

boards: list, get, view, columns, activity, create, update, delete, duplicate, createGroup/create_group.

boardItems/board_items: create, get, update, delete, duplicate, move, setCellValue/set_cell_value, listUpdates/list_updates, addUpdate/add_update.

Two details that save time: items are addressed at a flat URL, /boards/items/{id}, not nested under their board; and when creating a group the field is called name, not title. When writing a cell, the value is validated against the column type, and an empty string clears it.

Calendar, catalog, and sales

appointments: listCalendars/list_calendars, listServices/list_services, slots, list, book, update, cancel. A slot that's already taken responds 409, and passing starts_at in update reschedules and re-runs the conflict check.

products: list, get, create, update, delete.

orders: list, get, create, update, setStatus/set_status, recordPayment/record_payment, delete. The valid statuses are pending, confirmed, preparing, ready, shipped, delivered, and cancelled; an illegal transition responds 422 instead of doing nothing.

catalogSettings/catalog_settings: get, update, applyPreset/apply_preset.

quotes: list, get, create, update, delete, send, markViewed/mark_viewed, accept, reject, pdf, billingEntities/billing_entities. Sending the quote is what activates its public link, so a draft's link never resolves. The pdf method returns bytes, not JSON.

The catalog is cross-cutting: it doesn't depend on the CRM plan lock.

Automation and infrastructure

workflows: list, get, activate, deactivate, trigger.

webhooks: list, get, create, update, delete, rotateSecret/rotate_secret.

teams: list, get, create, update, delete, addMember/add_member, removeMember/remove_member.

workspaces: list, get, create, update, delete.

users (in Python also reachable as agents): me, logout, plus listAgents/getAgent/setAgentStatus in Node and list/get/update_status in Python.

reports: overview, conversations, agents, heatmap, crmFunnel/crm_funnel, crmForecast/crm_forecast, crmWinLossReasons/crm_win_loss_reasons. All of them accept a range; the preset wins over loose dates and, if you pass nothing, it's the last 30 days.

Tips

  • To close a deal, the pipeline needs a stage marked as won or lost; if there isn't one, the server responds 422.
  • Broadcasts are limited by plan: a plan without broadcasts responds 403.

Related articles

Was this helpful?

Related articles

Message us on WhatsApp