{"info":{"_postman_id":"561b9ff0-5172-43b6-a761-861c0f0295a6","name":"Origami API Documentation","description":"

Origami Public API Documentation

Verified against code (origami-webserver allow_api_external_access + field pipeline) and stage.origami.ms (2026-08-02 session harness + phone write/readback).

Local full refs: Origami_API_Complete_Reference.md v2.0 · Origami_API_Make_Field_Shapes.md · Origami_Finance_API_Documentation.md

Collection variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Meaning
`base_url`	e.g. `https://stage.origami.ms` or `https://YOUR_ACCOUNT.origami.ms`
`username`	API user email
`api_secret`	`OGMI-…` (must match the account in base_url)
`entity_data_name`	e.g. `e_76` from List All Entities
`instance_id`	Record Mongo `_id`
`group_data_name`	e.g. `g_175` from entity_structure
`field_data_name`	e.g. `fld_1057`

Platform rules (verified)

Errors often return HTTP 200 + {\"error\":...} — always branch on body.
Filters MUST be array-of-arrays: [[\"fld\",\"=\",\"val\"],...]. Wrong shape (array of objects) silently returns ALL records (stage-confirmed).
Pagination is ONLY \"limit\": [skip, count]. page / offset do nothing.
Request flag \"normalized\":\"1\" flattens the response and DROPS phone normalize (country code) and field metadata.
Auth is body username + api_secret (OGMI-…). Secrets are per account — webmark secret does not work on stage.
Prefer Content-Type: application/json + /format/json URL suffix (except archive_action, multipart upload).

Phone field (`input-telephone`) — nested read only

When reading WITHOUT normalized:\"1\", a phone field may look like:

{\n  \"value\": \"501234567\",\n  \"normalize\": {\n    \"country_code\": \"972\",\n    \"normalized_short\": \"501234567\",\n    \"normalize_full\": \"972501234567\"\n  }\n}\n

No key named prefix — use normalize.country_code (no +).
normalize is optional (missing on some legacy/unparseable values).
Stage write \"+972501234567\" → read value:\"501234567\" + full normalize object.

External endpoint map

Entities: entities_list, entity_structure, instance_data, instance_data_protected, create_instance, update_instance_fields, add/remove_group_repetition, remove_instance, archive_action, upload_file, file, send_email, send_sms, instances_history, calander_view_details
Invoices: create_invoice, instance_data
UI: push_notification, translate
Omnichannel: new_message

Changelog

2026-08-02 (v2 sync): Full description rewrite; update-by-field-type samples; phone normalize (stage-verified); pagination/filter warnings; create bulk notes; omnichannel Duplicate Message casing; archive/comms/history folders; nested read request.
2026-07-31: delivery_note/work_order, file POST download, push minutes, external_unique_id draft.

PBX app (folder 16)

Provider webhook — not username/api_secret auth. Uses per-line secret_key.

Public URL (from PBX admin “call entry URL”):\n{PUBLIC_URL}pbx_app/endpoint_pbx/{ORIGAMI_ACCOUNT}/{account_ukey}

Example: https://public.origami.ms/pbx_app/endpoint_pbx/stage/1712345678_12345

Public relay → internal pbx_app/api_public/endpoint_pbx_app with:\n{ account_id: \"pbx_\"+account_ukey, data: <payload>, external_service_name: \"pbx_app_external\" }

Payload fields (admin lang docs + code): call_id, secret_key, from, to, extension, sending_type (incoming/outgoing), call_status (answered/busy/rejected/missed), call_sub_status (empty or call_completed), call_start_time, call_end_time, call_duration, call_recording_link, call_summary.

HTTP errors (code): 400 invalid_payload / missing_required_fields / missing_secret_key · 403 invalid_secret · 404 unknown_account · 200 status:1 · 502 upstream_failure (relay).

Session-only UI APIs (not in this folder): pbx_app/api/get_messages, outgoing_call (browser session).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Origami Public API Documentation","slug":"origami-public-api-documentation"}],"owner":"2653695","collectionId":"561b9ff0-5172-43b6-a761-861c0f0295a6","publishedId":"2s93kz65gS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-05-28T08:26:06.000Z"},"item":[{"name":"1. Entity Structure","item":[{"name":"List All Entities","id":"6f00ac11-04f0-4102-aac1-db184d5313e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\"\n}"},"url":"https://stage.origami.ms/entities/api/entities_list/format/json","description":"

Returns every entity available to the API user.

Response (array):

[\n  {\"entity_name\":\"Entity1\",\"entity_data_name\":\"e_76\",\"protected_entity\":\"0\"},\n  {\"entity_name\":\"origami_users\",\"entity_data_name\":\"origami_users\",\"protected_entity\":\"1\"}\n]\n

protected_entity:\"1\" → use instance_data_protected (SUPA API user). Stage examples: origami_users, origami_user_groups, origami_invoices, origami_payments.
Stage sample size: hundreds of entities depending on account.

\n","urlObject":{"path":["entities","api","entities_list","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f00ac11-04f0-4102-aac1-db184d5313e3"},{"name":"Get Entity Structure (Fields & Groups)","id":"6e5ef9d3-6782-487f-b1d3-fca5dd320642","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\"\n}"},"url":"https://stage.origami.ms/entities/api/entity_structure/format/json","description":"

Schema for one entity. Required reading before create/update.

Response top-level: entity_data, instance_data (groups).

Each field includes:

field_data_name — use in filters/updates (fld_NNNN)
field_type_name — drives value shape (phone, relation, file, …)
field_name, required/validation, possible_values

Stage e_76 example types: input-telephone, select-from-entity, upload-files, formula-field, assign-field, input-address, wysiwyg, multi-value-*, checkbox, datetime, …

\n","urlObject":{"path":["entities","api","entity_structure","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e5ef9d3-6782-487f-b1d3-fca5dd320642"}],"id":"6ce86072-9dc6-44c2-ae3e-09f02d80085a","description":"

Discover entities and field schemas. Call these before create/update so you know entity_data_name, group_data_name, field_data_name, and field_type_name.

\n","_postman_id":"6ce86072-9dc6-44c2-ae3e-09f02d80085a"},{"name":"2. Create Instance","item":[{"name":"Create Instance","id":"49d7e25c-bd95-44a3-9a28-0b72e3fbc6b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"form_data\": [\n {\n \"group_data_name\": \"g_175\",\n \"data\": [{\n \"fld_910\": \"API sample title\",\n \"fld_3556\": \"notes\"\n }]\n }\n ]\n}"},"url":"https://stage.origami.ms/entities/api/create_instance/format/json","description":"

Create one record.

Rules

Each group block: one object in data holding all that group's fields (repeatable: one object per row).
Relations / user fields: plain instance id string — not {{instance_id, text}} (invalid ID).
Phone: string e.g. \"+972501234567\" or \"050-1234567\".
Success: {{\"success\":\"ok\",\"results\":{{\"_id\":\"…\"}}}}
Validation: {{\"error\":{{\"type\":\"validation\",\"column\":[{{\"field_data_name\",\"message\",…}}]}}}}
Stage: missing required field in another group fails even if you filled this group.

Optional

\"bulk\": \"1\" + form_data = array of records, max 200
\"force_workflow_async\": true

\n","urlObject":{"path":["entities","api","create_instance","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"49d7e25c-bd95-44a3-9a28-0b72e3fbc6b9"},{"name":"Create Instance (Multiple Groups)","id":"1e10e3a0-36e6-4155-be08-ff21d4e1e7ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"form_data\": [\n {\n \"group_data_name\": \"g_175\",\n \"data\": [{ \"fld_910\": \"Required F1\", \"fld_3556\": \"area text\" }]\n },\n {\n \"group_data_name\": \"origami_calendar_group\",\n \"data\": [{}]\n }\n ]\n}"},"url":"https://stage.origami.ms/entities/api/create_instance/format/json","description":"

Create with multiple groups in one call. Include every required field across groups (discover via entity_structure).

Replace field_data_names with yours from structure — sample ids are stage e_76 oriented.

\n","urlObject":{"path":["entities","api","create_instance","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e10e3a0-36e6-4155-be08-ff21d4e1e7ec"},{"name":"Create Instance (Bulk max 200)","id":"d9262150-bd7d-41f8-b020-996b2e08e3c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"bulk\": \"1\",\n \"form_data\": [\n [\n { \"group_data_name\": \"g_175\", \"data\": [{ \"fld_910\": \"Row A\" }] }\n ],\n [\n { \"group_data_name\": \"g_175\", \"data\": [{ \"fld_910\": \"Row B\" }] }\n ]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/create_instance/format/json","description":"

Bulk create: \"bulk\":\"1\". form_data is an array of records (each record is the usual group array). Max 200 per call (code-enforced).\nAdjust field names to required fields for your entity.

Create records. Use form_data (NOT the update field-triples shape). Required fields in ALL groups must be sent or you get validation.column[].

\n","_postman_id":"7767035d-837d-406c-ae9f-0cefad16ed4c"},{"name":"3. Read / Query Data","item":[{"name":"Select Nested (keep phone normalize / field objects) ★","id":"4090f34f-17c3-4cf8-9cda-6f9fbd92282a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"limit\": [0, 50]\n}"},"url":"https://stage.origami.ms/entities/api/instance_data/format/json","description":"

DEFAULT nested response — use this for Make field mapping (phone country code, relations, files).

Response shape:

{ info: { total_count }, entity_data, data: [\n  { instance_data: {\n      _id, insertTimestamp, field_groups: [\n        { field_group_data, fields_data: [[ { field_data_name, field_type_name, value, group_index, normalize? } ]] }\n      ]\n  } }\n] }\n

Phone field (`input-telephone`) — nested read only

When reading WITHOUT normalized:\"1\", a phone field may look like:

{\n  \"value\": \"501234567\",\n  \"normalize\": {\n    \"country_code\": \"972\",\n    \"normalized_short\": \"501234567\",\n    \"normalize_full\": \"972501234567\"\n  }\n}\n

No key named prefix — use normalize.country_code (no +).
\n
normalize is optional (missing on some legacy/unparseable values).
\n
Stage write \"+972501234567\" → read value:\"501234567\" + full normalize object.
\n
Metadata fields: value is often in default_value, not value.
\n
Stage: total_count + data[] confirmed on e_76.
\n

\n","urlObject":{"path":["entities","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"4090f34f-17c3-4cf8-9cda-6f9fbd92282a"},{"name":"Select Flattened (normalized:1) — loses phone normalize","id":"9ba33b73-7947-4d70-9f7c-d57e6b216cb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"limit\": [0, 50],\n \"normalized\": \"1\"\n}"},"url":"https://stage.origami.ms/entities/api/instance_data/format/json","description":"

Flattens to:

[{ \"id\":\"…\", \"insertTimestamp\":\"…\", \"g_175\": { \"fld_x\": \"scalar\" } }]\n

⚠ Drops phone normalize, field_id, field_type_name. Stage-confirmed no normalize leak.\nEmpty results may keep nested shape — handle both.\ninfo.total_count is dropped when transform runs.

\n","urlObject":{"path":["entities","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ba33b73-7947-4d70-9f7c-d57e6b216cb1"},{"name":"Select with Pagination limit:[skip,count]","id":"ced4a473-530e-445a-919b-378824e13ba2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"limit\": [0, 2]\n}"},"url":"https://stage.origami.ms/entities/api/instance_data/format/json","description":"

Pagination = limit: [skip, count] only.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Example	Meaning
`[0, 50]`	first 50
`[50, 50]`	next 50
`50`	same as `[0, 50]`

Max count 500 (1000 on-prem). page / offset / skip / start do NOTHING.\nStage: [0,2] vs [2,2] returned disjoint ids.

\n","urlObject":{"path":["entities","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"ced4a473-530e-445a-919b-378824e13ba2"},{"name":"Select by ID","id":"fc0cfc83-789b-497c-b80b-62db9c13f9f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"limit\": [0, 5]\n}"},"url":"https://stage.origami.ms/entities/api/instance_data/format/json","description":"

_id IS filterable. Stage: exact match returns 1 row.

\"filter\": [[\"_id\", \"=\", \"6a6f94428e10b823460eb692\"]]\n

\n","urlObject":{"path":["entities","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc0cfc83-789b-497c-b80b-62db9c13f9f5"},{"name":"Select with Filter","id":"33281019-5c96-48eb-a49f-68e66a44ac87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"fld_1057\", \"like\", \"05\"]],\n \"limit\": [0, 50]\n}"},"url":"https://stage.origami.ms/entities/api/instance_data/format/json","description":"

Filter syntax (AND)

\"filter\": [[\"fld_x\", \"=\", \"val\"], [\"fld_y\", \"like\", \"abc\"]]\n

Operators: =, <, <=, >, >=, like, not like, IN, NOT IN, EMPTY, NOT EMPTY
Dates: today, yesterday, date_range, x_days_back, last_7_days, …
Geo: [\"fld_loc\",\"geo\",{{\"lat\":32.0,\"lng\":34.7,\"radius\":5}}]

🔴 CRITICAL

Wrong shape e.g. [{{\"field\":\"x\",\"op\":\"=\",\"value\":\"y\"}}] does NOT error — returns ALL records unfiltered (stage: good filter 0 rows, bad shape 5 rows).

\n","urlObject":{"path":["entities","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"33281019-5c96-48eb-a49f-68e66a44ac87"},{"name":"Select with orderby","id":"55d5d366-c032-427c-ac05-c62e608c28c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"limit\": [0, 20],\n \"orderby\": [\"_id\", \"desc\"]\n}"},"url":"https://stage.origami.ms/entities/api/instance_data/format/json","description":"

orderby: e.g. [\"fld_data_name\",\"asc\"|\"desc\"] or [\"_id\",\"desc\"].
Field sorts use Mongo sort.fld_<id>. _id maps to insertTimestamp when skip is not huge.\nStage: accepted and returned rows.\nOptional: return_fields, return_groups, with_archive: 0 (exclude archived).

\n","urlObject":{"path":["entities","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"55d5d366-c032-427c-ac05-c62e608c28c5"},{"name":"Select Including Archived","id":"48f05021-e40f-46da-86e7-a10130e9cb6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"limit\": [0, 50],\n \"with_archive\": 1\n}"},"url":"https://stage.origami.ms/entities/api/instance_data/format/json","description":"

with_archive: 0 forces exclude archived (when entity allows archive).
Unset / non-zero → archived not filtered out.
info.total_count still counts active only.

instance_data reads. Use nested (default) when you need phone country code or relation objects. Use normalized:1 only for simple flat maps.

\n","_postman_id":"f250f857-8bd5-494f-948b-c9217669e7e3"},{"name":"4. Update Fields (by type)","item":[{"name":"Update — Text / Area / Email / Link","id":"d93a480a-6ae9-4882-9fc6-62a2acff422c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_title\", \"Hello world\", 0],\n [\"fld_notes\", \"Longer text\", 0],\n [\"fld_email\", \"a@example.com\", 0],\n [\"fld_website\", \"https://example.com\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Types: input-text, input-area, input-email, input-link. Strings.

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"d93a480a-6ae9-4882-9fc6-62a2acff422c"},{"name":"Update — Phone (input-telephone) ★","id":"55df05af-6fcd-480f-b628-d4d1a99a5093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_1057\", \"+972501234567\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Type: input-telephone.

Send a string (national or E.164-ish). Also valid: \"050-1234567\", \"0501234567\".

Stage-verified write→read:

Write: \"+972501234567\"
Read nested: value: \"501234567\", normalize: { country_code: \"972\", normalize_full: \"972501234567\", normalized_short: \"501234567\" }

There is no separate prefix key — country code is normalize.country_code on read (omit normalized:1).

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"55df05af-6fcd-480f-b628-d4d1a99a5093"},{"name":"Update — Checkbox","id":"9f98caa1-fedb-4c6c-9302-cf24a4e518ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_active\", \"1\", 0],\n [\"fld_opt_out\", \"0\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Type: input-checkbox-singel. Write \"1\"/\"0\" (true/false also accepted). Read usually \"1\"/\"0\".

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f98caa1-fedb-4c6c-9302-cf24a4e518ff"},{"name":"Update — Select list / Icons","id":"dd41d22a-ccc6-4d75-a2d1-8f7b2a8daf32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_status\", \"Open\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Types: select-list, icons-list. Value must match a configured option (possible_values / structure).

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd41d22a-ccc6-4d75-a2d1-8f7b2a8daf32"},{"name":"Update — Number / Slider","id":"343fc1ce-940c-4f3b-adb8-0196dfeb630f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_score\", 7, 0],\n [\"fld_slider\", 42, 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Types: select-from-numbers-range, slider-selector. Numeric values.

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"343fc1ce-940c-4f3b-adb8-0196dfeb630f"},{"name":"Update — Date / Time","id":"6c180f78-8787-4336-9614-aec51c99ea88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_due\", \"02/08/2026\", 0],\n [\"fld_time\", \"14:30\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Types: input-datetime, input-time. Use field format / account locale (d/m/Y vs m/d/Y).

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c180f78-8787-4336-9614-aec51c99ea88"},{"name":"Update — Multi-value tags","id":"3e32fe55-0142-4d5b-83ff-18f419529ee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_tags\", [\"vip\", \"newsletter\", \"he\"], 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Types: multi-value-select-box, multi-value-free-type.
Replaces the whole list (not append). Clear: [].

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e32fe55-0142-4d5b-83ff-18f419529ee3"},{"name":"Update — Relation / User (plain id string) ★","id":"b0c99aa3-9fb8-4884-9d41-9a9ace94944c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_customer\", \"69de27bb69e487f6490b8a88\", 0],\n [\"fld_owner\", \"-2\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Types: select-from-entity, user-field.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Direction	Shape
Read	`{{ \"instance_id\":\"…\", \"text\":\"Label\" }}`
Update write	plain id string only

\"-2\" = current API user. Sending the full object often → \"invalid ID\".

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"b0c99aa3-9fb8-4884-9d41-9a9ace94944c"},{"name":"Update — Multi-relation / Assign","id":"2b5c2cc2-31ac-4e48-af23-16b0f0591cfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_contacts\", [\"69de27bb69e487f6490b8a88\", \"6a33ad3109e1ae5da0078855\"], 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Types: multi-select-from-entity, assign-field. Array of instance ids. Replaces set. Clear: [].

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b5c2cc2-31ac-4e48-af23-16b0f0591cfc"},{"name":"Update — Address","id":"fc3311b2-502f-4335-bbd1-3903617b3d05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_addr\", {\n \"value\": \"Rothschild 1, Tel Aviv\",\n \"lnglat\": [34.7818, 32.0853]\n }, 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Type: input-address. lnglat = [lng, lat] numeric. Incomplete objects fail validation.

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc3311b2-502f-4335-bbd1-3903617b3d05"},{"name":"Update — API field","id":"b70def83-f4ba-4f43-8d84-146386b9aeb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_ext\", { \"id\": \"EXT-99\", \"text\": \"External label\" }, 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Type: api-field. Both id and text required, max 255 each.

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"b70def83-f4ba-4f43-8d84-146386b9aeb3"},{"name":"Update — Wysiwyg HTML","id":"62afbff8-3d8c-4b52-8536-5a0d4ae6a22d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_body\", \"

Hello world

\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Type: wysiwyg. HTML string; scripts stripped.

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"62afbff8-3d8c-4b52-8536-5a0d4ae6a22d"},{"name":"Update — File attach (after upload_file)","id":"5d502f68-b105-44f1-83ae-3a5fe110d0ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_attachment\", \"\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Type: upload-files (signature similar).

Run Upload File → copy results._id into file_id variable
Run this update

Also accepted: {{ \"file_id\": \"\" }}. Clear: \"\" or \"0\".

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d502f68-b105-44f1-83ae-3a5fe110d0ec"},{"name":"Update — Mixed multi-field","id":"ade4fd78-db78-43d4-8c9c-88d52757ef0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_910\", \"Acme lead\", 0],\n [\"fld_1057\", \"+972547790966\", 0],\n [\"fld_email\", \"lead@acme.com\", 0],\n [\"fld_active\", \"1\", 0],\n [\"fld_tags\", [\"hot\", \"il\"], 0],\n [\"fld_customer\", \"69de27bb69e487f6490b8a88\", 0],\n [\"fld_owner\", \"-2\", 0]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

One call, many field types. Replace fld_* with your structure names. Stage update success body includes instances_updated + fields_updated_total.

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"ade4fd78-db78-43d4-8c9c-88d52757ef0b"},{"name":"Update — Repeatable group cell","id":"f33cf160-cecd-498b-a359-1c945e454b93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]],\n \"field\": [\n [\"fld_line_qty\", 5, 2],\n [\"fld_line_desc\", \"Widget x5\", 2]\n ]\n}"},"url":"https://stage.origami.ms/entities/api/update_instance_fields/format/json","description":"

Third element 2 = row's stored group_index from nested read (not array position).
Add/remove rows: folders 6. Repeatable Groups.

Envelope rules

Triple: [field_data_name, value, group_index]
group_index = 0 non-repeatable; repeatable = stored group_index from nested read
Always filter by _id for single-record safety
Success (stage): {\"success\":\"ok\",\"results\":{\"instances_updated\":1,\"fields_updated_total\":N}}
NOT form_data (create only). JSON body required.

\n","urlObject":{"path":["entities","api","update_instance_fields","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"f33cf160-cecd-498b-a359-1c945e454b93"}],"id":"c39a0c26-d807-4e65-9eec-640777c70950","description":"

update_instance_fields — one request per value shape. Replace field_data_names with yours from entity_structure. Stage-verified phone + update success body.

\n","_postman_id":"c39a0c26-d807-4e65-9eec-640777c70950"},{"name":"5. Remove Instance","item":[{"name":"Remove by IDs Array","id":"ef11d154-46a8-47eb-a072-f3379018287f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"_ids\": [\"\"]\n}"},"url":"https://stage.origami.ms/entities/api/remove_instance/format/json","description":"

Permanent delete. _ids is always an array (even for one id).
Wrong param / form-urlencoded can yield misleading 403.

\n","urlObject":{"path":["entities","api","remove_instance","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef11d154-46a8-47eb-a072-f3379018287f"},{"name":"Remove by Filter (careful)","id":"f6792e6c-1932-4b9b-8655-f4bd316689f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"filter\": [[\"_id\", \"=\", \"\"]]\n}"},"url":"https://stage.origami.ms/entities/api/remove_instance/format/json","description":"

Filter-based delete. Prefer _ids for API. Wrong filter shape is dangerous.

Hard delete is permanent. Prefer archive (folder 8) when soft-delete is enough.

\n","_postman_id":"6f3709a0-dc65-4dfb-8e6a-84cabd9d36fa"},{"name":"6. Repeatable Groups","item":[{"name":"Add Group Repetition","id":"13865f2d-0e28-4c41-ad1f-f29d39af8263","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"_id\": \"\",\n \"group_data_name\": \"g_175\",\n \"group_data\": {\n \"fld_line_desc\": \"New line\",\n \"fld_line_qty\": 1\n }\n}"},"url":"https://stage.origami.ms/entities/api/add_group_repetition/format/json","description":"

Adds a row; enforces required fields in that group. Returns new_max_group_index.
Optional: bulk:\"1\", force_workflow_async.

\n","urlObject":{"path":["entities","api","add_group_repetition","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"13865f2d-0e28-4c41-ad1f-f29d39af8263"},{"name":"Remove Group Repetition","id":"04616d3f-7002-41f0-be10-76ce43b63f37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"_id\": \"\",\n \"group_data_name\": \"g_175\",\n \"index\": 0\n}"},"url":"https://stage.origami.ms/entities/api/remove_group_repetition/format/json","description":"

index = the row's stored group_index, NOT its position in the array (they diverge after remove+add). Read the cell first.

\n","urlObject":{"path":["entities","api","remove_group_repetition","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"04616d3f-7002-41f0-be10-76ce43b63f37"}],"id":"62b97c81-1b6d-4176-902d-04a5d22eb214","description":"

Add/remove rows in repeatable groups. Edit cells via Update Fields with stored group_index.

\n","_postman_id":"62b97c81-1b6d-4176-902d-04a5d22eb214"},{"name":"7. Files","item":[{"name":"Upload File","id":"c167b91e-9446-41cd-9cc5-9a0944908360","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"","type":"text"},{"key":"api_secret","value":"","type":"text"},{"key":"file","type":"file","src":[]}]},"url":"https://stage.origami.ms/entities/api/upload_file/format/json","description":"

Multipart form-data:

username, api_secret
binary part name file (not userfile)

Returns file reference e.g. results._id — set collection variable file_id, then Update — File attach.

Does not link to a field automatically. ~80 MB; plan attachment quota.

\n","urlObject":{"path":["entities","api","upload_file","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"c167b91e-9446-41cd-9cc5-9a0944908360"},{"name":"Download File (POST + credentials) ★","id":"704b68e1-1452-4b89-af30-a839b02cd8c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\"\n}"},"url":"https://stage.origami.ms/entities/api/file?f=","description":"

API credential recipe (verified):

POST https://stage.origami.ms/entities/api/file?f=\nContent-Type: application/json\n{\"username\":\"…\",\"api_secret\":\"…\"}\n

GET works only with browser session — query-string secrets are ignored (user not loggin).
Missing id (stage): {\"error\":{\"type\":\"error\",\"message\":\"Not Found\"}}.

\n","urlObject":{"path":["entities","api","file"],"host":["https://stage.origami.ms"],"query":[{"key":"f","value":""}],"variable":[]}},"response":[],"_postman_id":"704b68e1-1452-4b89-af30-a839b02cd8c3"}],"id":"b4f8de78-d27b-43d1-9d9e-fa1252dcc4e9","description":"

Upload does NOT attach to a record. Download for API credentials is POST with body auth (GET is session-only).

\n","_postman_id":"b4f8de78-d27b-43d1-9d9e-fa1252dcc4e9"},{"name":"8. Archive","item":[{"name":"Archive Record (type:in)","id":"ed0416ab-486c-40df-a90c-cc9ec1f73058","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"id\": \"\",\n \"type\": \"in\"\n}"},"url":"https://stage.origami.ms/entities/api/archive_action","description":"

Soft-archive. Success: {\"success\":\"ok\"}.
Errors: invalid_type, entity_data_name_require, id_require, check_data.
Stage: type:\"nope\" → invalid_type.

\n","urlObject":{"path":["entities","api","archive_action"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed0416ab-486c-40df-a90c-cc9ec1f73058"},{"name":"Unarchive Record (type:out)","id":"9c76324e-c5ab-4cb4-b938-daebbefd4270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"id\": \"\",\n \"type\": \"out\"\n}"},"url":"https://stage.origami.ms/entities/api/archive_action","description":"

Restore archived record. type: \"out\".

Soft delete / restore. Endpoint has NO /format/json suffix.

\n","_postman_id":"bb1a63ee-6316-41aa-92eb-980c74a0e9eb"},{"name":"9. Calendar Events","item":[{"name":"Create with Calendar Event","id":"aa15b23a-36d4-4134-be06-44649a5e6b0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"form_data\": [\n {\n \"group_data_name\": \"origami_calendar_group\",\n \"data\": [{\n \"origami_calendar_field\": {\n \"title\": \"Meeting\",\n \"start\": \"2026-08-10 10:00\",\n \"end\": \"2026-08-10 11:00\"\n }\n }]\n }\n ]\n}"},"url":"https://stage.origami.ms/entities/api/create_instance/format/json","description":"

Calendar entities need valid calendar field payload (server runs check_calander_validations_and_prepper).
Adjust field names via entity_structure. View listing: Calendar View Details (path calander_view_details).

\n","urlObject":{"path":["entities","api","create_instance","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa15b23a-36d4-4134-be06-44649a5e6b0c"},{"name":"Calendar View Details (calander spelling)","id":"8485b2b2-d217-44be-9f1e-8dc963e8afa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"start\": \"2026-08-01\",\n \"end\": \"2026-08-31\"\n}"},"url":"https://stage.origami.ms/entities/api/calander_view_details/format/json","description":"

Spelling is calander in the URL (not calendar).

Required: start + end (valid dates). entity_data_name and/or widget_id.
Optional: filter, resource_filter, custom_view_ids, other_calenders, view.
Stage non-calendar entity may return No Results query error.

\n","urlObject":{"path":["entities","api","calander_view_details","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"8485b2b2-d217-44be-9f1e-8dc963e8afa7"}],"id":"2fddd076-aff3-4372-8ffd-8ea33e000846","description":"

Creating calendar-entity records. View query is under History & Calendar View (spelling calander).

\n","_postman_id":"2fddd076-aff3-4372-8ffd-8ea33e000846"},{"name":"10. Protected Entities","item":[{"name":"Select Protected Entity Data","id":"40a50ca5-c7dc-400b-bdee-cfdbb6f44431","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"origami_users\",\n \"limit\": [0, 10]\n}"},"url":"https://stage.origami.ms/entities/api/instance_data_protected/format/json","description":"

Same params as instance_data. Non-SUPA → permission error. Normal instance_data returns no access for protected entities.

\n","urlObject":{"path":["entities","api","instance_data_protected","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"40a50ca5-c7dc-400b-bdee-cfdbb6f44431"}],"id":"367410b2-1daa-4091-acd6-b2d26902abc0","description":"

protected_entity=1 (users, invoices entity, …) requires this endpoint + SUPA API user.

\n","_postman_id":"367410b2-1daa-4091-acd6-b2d26902abc0"},{"name":"11. Push Notifications","item":[{"name":"Send Push Notification","id":"defdf77f-71ee-4719-aa54-ed0b68fc64de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"user_id\": \"\",\n \"text\": \"Hello from API\",\n \"duration\": \"10\",\n \"id\": \"push-1\",\n \"button\": {\n \"type\": \"link\",\n \"url\": \"https://example.com\"\n }\n}"},"url":"https://stage.origami.ms/ui/api/push_notification","description":"

duration is minutes (code comment). 0 = sticky (never auto-dismiss).
user_id = origami user instance id
button optional: type link|location; location can target entity/invoice
id = update id (reuse to update existing notification)

\n","urlObject":{"path":["ui","api","push_notification"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"defdf77f-71ee-4719-aa54-ed0b68fc64de"}],"id":"340c4434-2a23-4547-bec0-5e1a45619b16","description":"

In-app push to a logged-in Origami user.

\n","_postman_id":"340c4434-2a23-4547-bec0-5e1a45619b16"},{"name":"12. Invoice System","item":[{"name":"Create Tax Invoice Receipt","id":"44361be5-052d-4adf-b8cf-8e271e437684","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"type\": \"tax_receipt\",\n \"saved_id\": \"\",\n \"round_total\": 0,\n \"form_data\": [\n {\n \"group_data_name\": \"origami_invoices_general_details\",\n \"data\": [\n {\n \"\": \"\"\n }\n ]\n }\n ]\n}"},"url":"https://stage.origami.ms/invoices/api/create_invoice","description":"

Creates a Tax Invoice Receipt (חשבונית מס קבלה) — the most common document type in Israel. Uses the origami_invoices_general_details group for form data.

type: tax_receipt\ngroup_data_name: origami_invoices_general_details

Origami automatically assigns a sequential document number and creates a PDF. Success response includes _id, file_id (for the PDF), and doc_number.

\n","urlObject":{"path":["invoices","api","create_invoice"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"44361be5-052d-4adf-b8cf-8e271e437684"},{"name":"Create Tax Invoice","id":"85d9310d-289b-437d-9eae-6516a715be60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"type\": \"tax_invoice\",\n \"saved_id\": \"\",\n \"round_total\": 0,\n \"form_data\": [\n {\n \"group_data_name\": \"origami_invoices_general_details\",\n \"data\": [{}]\n }\n ]\n}"},"url":"https://stage.origami.ms/invoices/api/create_invoice","description":"

Creates a Tax Invoice (חשבונית מס) — a tax invoice without a receipt component.

type: tax_invoice\ngroup_data_name: origami_invoices_general_details

IMPORTANT: All invoice types use the same group_data_name — all five invoice types use origami_invoices_general_details.

\n","urlObject":{"path":["invoices","api","create_invoice"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"85d9310d-289b-437d-9eae-6516a715be60"},{"name":"Create Receipt","id":"7e5e0e0a-e15e-49d2-a7b9-5532af1e58c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"type\": \"receipt\",\n \"saved_id\": \"\",\n \"round_total\": 0,\n \"form_data\": [\n {\n \"group_data_name\": \"origami_invoices_general_details\",\n \"data\": [{}]\n }\n ]\n}"},"url":"https://stage.origami.ms/invoices/api/create_invoice","description":"

Creates a Receipt (קבלה).

type: receipt\ngroup_data_name: origami_invoices_general_details

\n","urlObject":{"path":["invoices","api","create_invoice"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e5e0e0a-e15e-49d2-a7b9-5532af1e58c1"},{"name":"Create Proforma Invoice","id":"bc2b2525-89b8-4c6b-ba18-5bb52ef3ac7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"type\": \"deal_invoice\",\n \"saved_id\": \"\",\n \"round_total\": 0,\n \"form_data\": [\n {\n \"group_data_name\": \"origami_invoices_general_details\",\n \"data\": [{}]\n }\n ]\n}"},"url":"https://stage.origami.ms/invoices/api/create_invoice","description":"

Creates a Proforma Invoice (הצעת מחיר).

type: deal_invoice\ngroup_data_name: origami_invoices_general_details

\n","urlObject":{"path":["invoices","api","create_invoice"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc2b2525-89b8-4c6b-ba18-5bb52ef3ac7a"},{"name":"Create Work Order (הזמנת עבודה)","id":"77585255-7d6b-4750-94f4-e39f748691b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"type\": \"work_order\",\n \"saved_id\": \"\",\n \"round_total\": 0,\n \"form_data\": [\n {\n \"group_data_name\": \"origami_invoices_general_details\",\n \"data\": [{}]\n }\n ]\n}"},"url":"https://stage.origami.ms/invoices/api/create_invoice","description":"

Creates a Work Order (הזמנת עבודה) - added 2026-07 (#5813). type: work_order. VAT-bearing, own numbering series, NO IL Tax Authority provisioning, no cancel/convert. Same form_data shape as deal_invoice (general_details + items groups). Extras: origami_invoices_scheduled_date_fld, origami_invoices_hours_fld, origami_invoices_assignee_fld.

\n","urlObject":{"path":["invoices","api","create_invoice"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"77585255-7d6b-4750-94f4-e39f748691b4"},{"name":"Create Delivery Note (תעודת משלוח)","id":"e1c78364-8fdf-43f4-9338-3a29c7b54295","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"type\": \"delivery_note\",\n \"saved_id\": \"\",\n \"round_total\": 0,\n \"form_data\": [\n {\n \"group_data_name\": \"origami_invoices_general_details\",\n \"data\": [{}]\n }\n ]\n}"},"url":"https://stage.origami.ms/invoices/api/create_invoice","description":"

Creates a Delivery Note (תעודת משלוח) - added 2026-07 (#5813). type: delivery_note. VAT-bearing, own numbering series, NO IL Tax Authority provisioning, no cancel/convert. Same form_data shape as deal_invoice (general_details + items groups). Extras: origami_invoices_ship_to_fld, origami_invoices_carrier_fld.

\n","urlObject":{"path":["invoices","api","create_invoice"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"e1c78364-8fdf-43f4-9338-3a29c7b54295"},{"name":"Create Credit Invoice","id":"50032d17-ed92-4280-b8cf-426dd7c57281","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"type\": \"refund_invoice\",\n \"attach_type\": \"tax_invoice\",\n \"saved_id\": \"\",\n \"round_total\": 0,\n \"form_data\": [\n {\n \"group_data_name\": \"origami_invoices_general_details\",\n \"data\": [{}]\n }\n ]\n}"},"url":"https://stage.origami.ms/invoices/api/create_invoice","description":"

Creates a Credit Invoice / Refund (חשבונית זיכוי) — a credit note that references an existing invoice. Requires an additional attach_type parameter to specify which type of invoice is being credited.

type: refund_invoice\nattach_type: tax_invoice (or other invoice type being credited)\ngroup_data_name: origami_invoices_general_details

VERIFIED DETAILS (2026-07-31): the attach reference field (origami_invoices_attach_invoice_fld, or origami_invoices_attach_tax_receipt_fld when crediting a receipt/tax_receipt) MUST be an object {'instance_id':'...','text':'...'} — a bare string is silently ignored and the credit computes 0. attach_type special value 'manual' = standalone credit without a parent attach. Credit lines must send EXPLICIT item_total_fld + item_tax_fld + item_credited_fld. WARNING: no over-refund guard — the server never checks the parent's remaining balance.

\n","urlObject":{"path":["invoices","api","create_invoice"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"50032d17-ed92-4280-b8cf-426dd7c57281"},{"name":"Select Tax Invoice Receipts","id":"cfa8db75-4ac2-4bd7-a048-6d42424c8acc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"invoice_type\": \"tax_receipt\"\n}"},"url":"https://stage.origami.ms/invoices/api/instance_data/format/json","description":"

Retrieves Tax Invoice Receipt records. The response format is the same as entity instance_data — with info (pagination), entity_data, and data arrays.

invoice_type values: tax_receipt, tax_invoice, receipt, deal_invoice, refund_invoice, delivery_note, work_order, income_and_expences (read-only)

Supports the same filter and pagination parameters as entity queries.

Pagination: page is IGNORED here - use limit:[skip,count] (e.g. [0,50] then [50,50]); verified 2026-07-31.

\n","urlObject":{"path":["invoices","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"cfa8db75-4ac2-4bd7-a048-6d42424c8acc"},{"name":"Select Tax Invoices","id":"8b542032-b4a1-4db0-82b9-378f4accba2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"invoice_type\": \"tax_invoice\"\n}"},"url":"https://stage.origami.ms/invoices/api/instance_data/format/json","description":"

Retrieves Tax Invoice records. Same response format and filtering as entity instance_data.

\n","urlObject":{"path":["invoices","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"8b542032-b4a1-4db0-82b9-378f4accba2b"},{"name":"Select Receipts","id":"6d646a7f-a896-4bb1-b1da-cb9c0282627a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"invoice_type\": \"receipt\"\n}"},"url":"https://stage.origami.ms/invoices/api/instance_data/format/json","description":"

Retrieves Receipt records. Same response format and filtering as entity instance_data.

\n","urlObject":{"path":["invoices","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d646a7f-a896-4bb1-b1da-cb9c0282627a"},{"name":"Select Proforma Invoices","id":"ef28679c-c617-4ef7-8112-21df597069a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"invoice_type\": \"deal_invoice\"\n}"},"url":"https://stage.origami.ms/invoices/api/instance_data/format/json","description":"

Retrieves Proforma Invoice records. Same response format and filtering as entity instance_data.

\n","urlObject":{"path":["invoices","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef28679c-c617-4ef7-8112-21df597069a6"},{"name":"Select Credit Invoices","id":"112d35af-3442-4ea3-8d69-d5d45b5f26b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"invoice_type\": \"refund_invoice\"\n}"},"url":"https://stage.origami.ms/invoices/api/instance_data/format/json","description":"

Retrieves Credit Invoice / Refund records. Same response format and filtering as entity instance_data.

\n","urlObject":{"path":["invoices","api","instance_data","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"112d35af-3442-4ea3-8d69-d5d45b5f26b3"},{"name":"Create with external_unique_id (v6.3.6 - NOT YET RELEASED)","id":"2be1d236-ef71-4fc9-9bbb-29dede353cb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"type\": \"tax_receipt\",\n \"saved_id\": \"\",\n \"round_total\": 0,\n \"external_unique_id\": \"\",\n \"form_data\": [\n {\n \"group_data_name\": \"origami_invoices_general_details\",\n \"data\": [\n {}\n ]\n }\n ]\n}"},"url":"https://stage.origami.ms/invoices/api/create_invoice","description":"

DRAFT - DO NOT USE until v6.3.6 ships (ticket #6003, MR !1746). Optional idempotency key on create_invoice: pass external_unique_id = your clearing/payment transaction id (string, max 128 chars; unique per document type per account). Retry with the SAME key: completed -> returns the ORIGINAL document with duplicate:true (no new document); still running -> {code:'in_progress'}; different customer/total/currency -> {code:'conflict'}; malformed key -> {code:'invalid_external_unique_id'}; store unavailable -> {code:'idempotency_unavailable'} (document NOT created, safe retry). Reservation happens after validation and BEFORE IL Tax Authority provisioning. Integration rule: never blind-retry create_invoice on timeout - retry with the same key. All responses HTTP 200 - branch on body.

Finance app public endpoints: create_invoice + instance_data.

Full contract: Origami_Finance_API_Documentation.md
Types: deal_invoice, tax_invoice, tax_receipt, receipt, refund_invoice, delivery_note, work_order.
income_and_expences create broken (read-only).
⚠ Creating docs issues real legal numbers on production — use stage.

Stage: deal_invoice list returned rows + total_count 238 (2026-08-02).\nPagination: limit:[skip,count] works; page ignored.\nItem field is catalog instance id; global_discount required (send 0/percent).\nexternal_unique_id draft not released until v6.3.6.

\n","_postman_id":"20a2c78d-5252-4116-8edc-7f9f08a50d34"},{"name":"13. Communications","item":[{"name":"Send Email","id":"3fa63cb4-92fe-4c46-87e9-cecf7c9e4cca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"subject\": \"Hello\",\n \"msg\": \"

Body HTML

\",\n \"email_list\": [\"a@example.com\"],\n \"bcc\": 1\n}"},"url":"https://stage.origami.ms/entities/api/send_email/format/json","description":"

Required: subject, msg, email_list.
bcc:1 (default) BCC; 0 = To.
Cap: 500 API calls/day/account (not recipients).
Missing params (stage): \"subject, msg, email_list are must\".

\n","urlObject":{"path":["entities","api","send_email","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"3fa63cb4-92fe-4c46-87e9-cecf7c9e4cca"},{"name":"Send SMS","id":"935fde2c-bba1-4274-a60c-e02cd24427ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"instance_id\": \"\",\n \"phone_list\": [\"050-1234567\"],\n \"msg\": \"Your text\"\n}"},"url":"https://stage.origami.ms/entities/api/send_sms/format/json","description":"

Tied to a record for context/credits (workflow SMS sender). Required: entity_data_name, instance_id, phone_list, msg.

\n","urlObject":{"path":["entities","api","send_sms","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"935fde2c-bba1-4274-a60c-e02cd24427ea"}],"id":"7abe5fe6-852c-4acc-bf55-a7b62a4b827c","description":"

Email + SMS via entities API.

\n","_postman_id":"7abe5fe6-852c-4acc-bf55-a7b62a4b827c"},{"name":"14. History","item":[{"name":"Instances History","id":"9764579d-427e-4c5d-8bf6-a2db00495c80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"entity_data_name\": \"e_76\",\n \"id\": \"\",\n \"counter\": 20,\n \"offset\": 0\n}"},"url":"https://stage.origami.ms/entities/api/instances_history/format/json","description":"

counter = page size, offset = skip.
Stage sample: {\"error\":{\"type\":\"query\",\"message\":\"No Results\"}}.
add_instances_history_comment is session-only (not external whitelist).

\n","urlObject":{"path":["entities","api","instances_history","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"9764579d-427e-4c5d-8bf6-a2db00495c80"}],"id":"e0db26c8-1be2-48bf-96a6-f48c391617a7","description":"

Audit history. May return No Results if audit log not enabled for the account/context.

\n","_postman_id":"e0db26c8-1be2-48bf-96a6-f48c391617a7"},{"name":"15. Omnichannel External","item":[{"name":"New Message (inject)","id":"cc1eb7fe-8b51-49ad-8f37-e84ad54a840e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\",\n \"api_secret\": \"\",\n \"message_info\": {\n \"message_type\": \"text\",\n \"sending_type\": \"incoming\",\n \"message_text\": \"Hi, I would like a quote\",\n \"timestamp\": \"2026-08-02T14:30:00+03:00\",\n \"from\": \"+972501234567\",\n \"to\": \"+972541234567\",\n \"message_id\": \"unique-msg-id-001\"\n },\n \"properties\": { \"app_type\": \"whatsapp\" }\n}"},"url":"https://stage.origami.ms/omnichannel_external/api/new_message/format/json","description":"

Stage-verified:

First post: {\"status\":1}
Same message_id again: {\"status\":0,\"message\":\"Duplicate Message\"} (treat as success on retry)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Values
app_type	whatsapp \| email_app \| pbx_app only
sending_type	incoming \| outgoing
message_type	text, image, document, location, contacts, audio (no video)
media	properties.origami_files: [{{file_name, file_id}}] from upload_file

","urlObject":{"path":["omnichannel_external","api","new_message","format","json"],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc1eb7fe-8b51-49ad-8f37-e84ad54a840e"}],"id":"a20f90e6-be62-4052-9652-d971efcb614a","description":"

Write-only message inject. message_id is idempotency key.

\n","_postman_id":"a20f90e6-be62-4052-9652-d971efcb614a"},{"name":"16. PBX Webhook (provider)","item":[{"name":"Incoming — answered (ring / start)","id":"5082a27c-6948-4a22-a7fa-b06986e64988","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secret_key\": \"\",\n \"call_id\": \"call_1785824465\",\n \"from\": \"0501234567\",\n \"to\": \"039999999\",\n \"extension\": \"\",\n \"sending_type\": \"incoming\",\n \"call_status\": \"answered\",\n \"call_sub_status\": \"\",\n \"call_start_time\": \"2026-08-03 10:00:00\"\n}"},"url":"https://public.origami.ms/pbx_app/endpoint_pbx/stage/","description":"

First event for a new call (or status update while open).

Required fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Notes
`secret_key`	Must match PBX line config (else 403 `invalid_secret`)
`call_id`	Unique per call; used as omnichannel unique_id
`from` / `to`	Phone numbers (digits; normalized server-side)
`sending_type`	`incoming` or `outgoing`
`call_status`	e.g. `answered`, `busy`, `rejected`, `missed`

Field	Notes
`extension`	Maps to user `origami_user_pbx_extension` for screen-pop
`call_sub_status`	Empty string on start; `call_completed` when hung up
`call_start_time`	Stored when answered + empty sub_status

Success

{\"status\": 1}\n

HTTP 200.

Errors (HTTP code + body)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Body error	When
400	missing_secret_key	no secret in body
400	invalid_payload	(internal) missing account_id/data
400	missing_required_fields	missing secret_key or call_id in data
403	invalid_secret	secret mismatch
404	unknown_account	bad account id
502	upstream_failure	public→webserver relay failed

JSON body preferred. Form fields with secret_key also accepted by the public controller.

\n","urlObject":{"path":["pbx_app","endpoint_pbx","stage",""],"host":["https://public.origami.ms"],"query":[],"variable":[{"type":"any","value":"stage","key":"account"},{"type":"any","value":"","key":"account_ukey"}]}},"response":[],"_postman_id":"5082a27c-6948-4a22-a7fa-b06986e64988"},{"name":"Incoming — call_completed + recording","id":"f5e3158c-0044-49c1-bb51-42201295b02f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secret_key\": \"\",\n \"call_id\": \"\",\n \"from\": \"0501234567\",\n \"to\": \"039999999\",\n \"extension\": \"\",\n \"sending_type\": \"incoming\",\n \"call_status\": \"answered\",\n \"call_sub_status\": \"call_completed\",\n \"call_end_time\": \"2026-08-03 10:05:00\",\n \"call_duration\": \"300\",\n \"call_recording_link\": \"https://example.com/recordings/sample.mp3\",\n \"call_summary\": \"Customer asked about pricing\"\n}"},"url":"https://public.origami.ms/pbx_app/endpoint_pbx/stage/","description":"

Same call_id as the start event, with:

call_sub_status: call_completed
optional call_end_time, call_duration, call_recording_link, call_summary

When call_recording_link is a valid URL, Origami writes it to matching records across all configured entity mappings (multi-entity PBX).

Set collection var pbx_call_id to the call_id from the start request, or paste the same id in the body.

call_summary is HTML-escaped before store.

\n","urlObject":{"path":["pbx_app","endpoint_pbx","stage",""],"host":["https://public.origami.ms"],"query":[],"variable":[{"type":"any","value":"stage","key":"account"},{"type":"any","value":"","key":"account_ukey"}]}},"response":[],"_postman_id":"f5e3158c-0044-49c1-bb51-42201295b02f"},{"name":"Incoming — missed","id":"aa6bb42f-7c28-4274-bc80-8ae4fdcd70a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secret_key\": \"\",\n \"call_id\": \"missed_1785824465\",\n \"from\": \"0501234567\",\n \"to\": \"039999999\",\n \"extension\": \"\",\n \"sending_type\": \"incoming\",\n \"call_status\": \"missed\",\n \"call_sub_status\": \"\"\n}"},"url":"https://public.origami.ms/pbx_app/endpoint_pbx/stage/","description":"

call_status: missed. If line has screen_pop_on_missed and extension maps to a logged-in user, may screen-pop once (screen_pop_shown flag).

\n","urlObject":{"path":["pbx_app","endpoint_pbx","stage",""],"host":["https://public.origami.ms"],"query":[],"variable":[{"type":"any","value":"stage","key":"account"},{"type":"any","value":"","key":"account_ukey"}]}},"response":[],"_postman_id":"aa6bb42f-7c28-4274-bc80-8ae4fdcd70a2"},{"name":"Outgoing — answered","id":"c18de39f-3c36-47af-ad3e-e6f5eca1db03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secret_key\": \"\",\n \"call_id\": \"out_1785824465\",\n \"from\": \"039999999\",\n \"to\": \"0501234567\",\n \"extension\": \"\",\n \"sending_type\": \"outgoing\",\n \"call_status\": \"answered\",\n \"call_sub_status\": \"\"\n}"},"url":"https://public.origami.ms/pbx_app/endpoint_pbx/stage/","description":"

sending_type: outgoing. Contact lookup / screen-pop path is incoming-only in code; still logs omnichannel call record and ws refresh.

\n","urlObject":{"path":["pbx_app","endpoint_pbx","stage",""],"host":["https://public.origami.ms"],"query":[],"variable":[{"type":"any","value":"stage","key":"account"},{"type":"any","value":"","key":"account_ukey"}]}},"response":[],"_postman_id":"c18de39f-3c36-47af-ad3e-e6f5eca1db03"},{"name":"Error demo — bad secret (expect 403)","id":"f867d37c-c563-42f9-9bf7-eb41942446af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secret_key\": \"wrong-secret\",\n \"call_id\": \"badsec_1785824465\",\n \"from\": \"0501234567\",\n \"to\": \"039999999\",\n \"sending_type\": \"incoming\",\n \"call_status\": \"answered\",\n \"call_sub_status\": \"\"\n}"},"url":"https://public.origami.ms/pbx_app/endpoint_pbx/stage/","description":"

Expect HTTP 403 and {\"status\":0,\"error\":\"invalid_secret\"} when the account exists but secret is wrong.

PBX app — provider webhook API

Code: origami-public Pbx_app::endpoint_pbx → webserver pbx_app/api_public/endpoint_pbx_app.

Auth model

Not Origami API username / api_secret.
Per PBX line/account secret_key (shown in PBX app admin config).
Account identity is in the URL: .../endpoint_pbx/{account}/{account_ukey} → internal account_id = \"pbx_\" + account_ukey.

Where to get values

In Origami UI: PBX app → Manage config for the line:

Call entry URL → split into pbx_public_base + path (or paste full URL and edit)
Secret key → pbx_secret_key
User’s PBX extension field on origami_users → pbx_extension (for screen-pop to that agent)

What the webhook does (incoming)

Validates payload + secret
Upserts omnichannel call log by call_id
Resolves agent by extension
Multi-entity phone lookup (entity mapping priority) → screen-pop View/Create
On call_completed + recording URL → writeback to matching records across mappings
Websocket refresh of call UI

Session-only (not external provider)

POST /pbx_app/api/outgoing_call — click-to-call (logged-in user)
POST /pbx_app/api/get_messages — call log list in app UI

\n","_postman_id":"bb6a3da1-c3dd-427e-84d3-0f7857e11319"},{"name":"MCP Server","item":[{"name":"Connect Using Basic Auth","id":"4fb66710-fe9b-4a6e-be04-1d3518af297f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://stage.origami.ms/mcp/","description":"

https://{{ACCOUNT}}.origami.ms/mcp/ — Basic Auth. Tools include entity list/structure and data ops (collection note).

\n","urlObject":{"path":["mcp",""],"host":["https://stage.origami.ms"],"query":[],"variable":[]}},"response":[],"_postman_id":"4fb66710-fe9b-4a6e-be04-1d3518af297f"}],"id":"6e7ecc17-98cf-48ca-8082-a848ed0dd0fa","description":"

AI agent access via Basic Auth (not independently verified in the stage suite).

\n","_postman_id":"6e7ecc17-98cf-48ca-8082-a848ed0dd0fa"}],"variable":[{"key":"base_url","value":"https://stage.origami.ms"},{"key":"username","value":""},{"key":"api_secret","value":""},{"key":"entity_data_name","value":"e_76"},{"key":"instance_id","value":""},{"key":"group_data_name","value":"g_175"},{"key":"field_data_name","value":"fld_1057"},{"key":"file_id","value":""},{"key":"pbx_public_base","value":"https://public.origami.ms"},{"key":"pbx_account","value":"stage"},{"key":"pbx_account_ukey","value":""},{"key":"pbx_secret_key","value":""},{"key":"pbx_extension","value":""},{"key":"pbx_call_id","value":""}]}

Origami Public API Documentation

Collection variables

Platform rules (verified)

Phone field (input-telephone) — nested read only

External endpoint map

Changelog

PBX app (folder 16)

Rules

Optional

Phone field (input-telephone) — nested read only

Filter syntax (AND)

🔴 CRITICAL

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Envelope rules

Required fields

Recommended

Success

Errors (HTTP code + body)

PBX app — provider webhook API

Auth model

Where to get values

What the webhook does (incoming)

Session-only (not external provider)

Phone field (`input-telephone`) — nested read only

Phone field (`input-telephone`) — nested read only