{"info":{"_postman_id":"c621f084-cd6f-4b20-b0ff-e4afcff8506c","name":"OpusFlow External","description":"

Please contact your account manager to get access to the API.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15931551","collectionId":"c621f084-cd6f-4b20-b0ff-e4afcff8506c","publishedId":"2s93z59QFk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"212ab2"},"publishDate":"2023-06-22T10:44:01.000Z"},"item":[{"name":"Create project V3","event":[{"listen":"prerequest","script":{"id":"c155033a-3765-4170-a0de-4f6310301cd4","exec":[""],"type":"text/javascript","packages":{}}}],"id":"d3341c1a-6212-4b97-8ad7-f384aa602c01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"name":"cache-control","sortOrder":2,"infoTitle":"We recommend using this header","info":"Postman added \"Cache-Control: no-cache\" as a precautionary measure to prevent the server from returning stale response when one makes repeated requests.\n\nYou can remove this header in the app settings or enter a new one with a different value.","allowedToToggle":false,"disableEdit":true,"previewSettingsLink":"Go to settings","key":"Cache-Control","value":"no-cache","system":true,"type":"text"},{"name":"postman-token","sortOrder":3,"infoTitle":"We recommend using this header","info":"The Postman-Token header appends a random UUID to every outgoing request. Postman adds this header for API developers to better debug requests sent and to ensure separate requests appear distinct to the receiving server.\n\nYou can remove this header in the app settings.","allowedToToggle":false,"disableEdit":true,"previewSettingsLink":"Go to settings","key":"Postman-Token","value":"","system":true,"type":"text"},{"name":"content-type","sortOrder":4,"infoTitle":"This header was automatically added","info":"The Content-Type header is added to help the server identify the media type of the request body that is present in this request.\n\nUse the request body tab to control the value or to remove this header.","allowedToToggle":true,"disableEdit":true,"previewSettingsLink":"Go to body","key":"Content-Type","value":"application/json","system":true,"type":"text"},{"name":"content-length","sortOrder":5,"infoTitle":"This header was automatically added","info":"The Content-Length header was added to indicate to the server the size of the request body that is added to this request. Server uses this value to parse the request body accurately.\n\nYou can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"previewSettingsLink":"Go to body","key":"Content-Length","value":"","system":true,"type":"text"},{"name":"host","sortOrder":6,"infoTitle":"We recommend using this header","info":"The Host header is added to identify the domain name for which a request is being sent to the server. This header is implicitly sent by every HTTP client.\n\nYou can remove the header or enter a new one with a different value. It is most likely that without this header, your request will return an HTTP 400 error.","allowedToToggle":true,"disableEdit":true,"key":"Host","value":"","system":true,"type":"text"},{"name":"user-agent","sortOrder":7,"infoTitle":"We recommend using this header","info":"The User-Agent header is added to help the server identify Postman as the HTTP requesting application or client.\n\nIt is recommended that this header be sent, but you can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"key":"User-Agent","value":"PostmanRuntime/7.39.1","system":true,"type":"text"},{"name":"accept","sortOrder":8,"infoTitle":"We recommend using this header","info":"The \"Accept: */*\" header is added to tell the server that Postman can understand and process all forms of response content types.\n\nIt is recommended that this header be sent, but you can remove the header or enter a new one with a different value.","allowedToToggle":true,"disableEdit":true,"key":"Accept","value":"*/*","system":true,"type":"text"},{"name":"accept-encoding","sortOrder":9,"infoTitle":"We recommend using this header","info":"The Accept-Encoding header is added to indicate to the server that Postman HTTP client supports a defined list of content-encoding or compression algorithms as response.\n\nYou can remove the header or enter a new one with a different value. Doing that may not accurately render the response within the app.","allowedToToggle":true,"disableEdit":true,"key":"Accept-Encoding","value":"gzip, deflate, br","system":true,"type":"text"},{"name":"connection","sortOrder":10,"infoTitle":"We recommend using this header","info":"Postman added the Connection header to indicate the server to keep the underlying network connection open once the current response is received. This allows Postman to reuse the same connection for faster response times in subsequent requests to the same server.\n\nYou can remove this header or enter a new one with a different value, such as `Connection: Close` to control this behaviour.","allowedToToggle":true,"disableEdit":true,"key":"Connection","value":"keep-alive","system":true,"type":"text"},{"key":"org_id","value":"{{org_id}}","type":"text","id":0},{"key":"secret","value":"{{secret}}","type":"text","id":1}],"body":{"mode":"raw","raw":"{\r\n \"source_site\": \"Your lead Gen\",\r\n \"source_site_url\": \"https://your-lead-gen.nl\",\r\n \"company\": {\r\n \"name\": \"Test\",\r\n \"kvk\": \"123123\",\r\n \"tax\": \"NL123123\",\r\n \"email\": \"test@test.nl\",\r\n \"phone_number\": \"123123123\"\r\n },\r\n \"contact\": {\r\n \"first_name\": \"Johnny\",\r\n \"last_name\": \"Doe\",\r\n \"email\": \"test@domain.com\",\r\n \"phone_number\": \"1234567789\",\r\n \"comments\": \"Comment..\"\r\n },\r\n \"address\": {\r\n \"zip\": \"7421ZA\",\r\n \"house_number\": \"5\",\r\n \"street_name\": \"Maagdenburgstraat\",\r\n \"country\": \"NL\",\r\n \"city\": \"Deventer\",\r\n \"state\": \"Overijssel\",\r\n \"lat\": 55.333333,\r\n \"lng\": 6.44444\r\n },\r\n \"projects\": [\r\n {\r\n \"status\": 1,\r\n \"type\": 1,\r\n \"group\": 1,\r\n \"account_manager\": \"user_123123123\",\r\n \"comments\": \"HII\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3","description":"

The body below contains all possible fields in the API. Please use the example request button switcher to see different formats. (E.g. residential / commercial)

\n

PLEASE NOTE THAT THE \"custom_fields\" property on project requires you to fill in the ID of the custom field. They can be found in the settings.

\n","urlObject":{"protocol":"https","path":["api","project","v3"],"host":["app","opusflow","io"],"query":[],"variable":[]}},"response":[{"id":"58cb1c55-cce3-4421-a8f7-bce2be5120f5","name":"Commercial","originalRequest":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"source_site\": \"Your lead Gen\",\r\n \"source_site_url\": \"https://your-lead-gen.nl\",\r\n \"company\": {\r\n \"name\": \"Test company\",\r\n \"email\": \"test-company@company.nl\"\r\n },\r\n \"address\": {\r\n \"zip\": \"7421ZA\",\r\n \"house_number\": \"5\"\r\n },\r\n \"projects\": [\r\n {\r\n \"status\": 1,\r\n \"type\": 1,\r\n \"comments\": \"This is a comment\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"successfulProjectCount\": 1,\n \"failedProjectCount\": 0,\n \"successfulProjectIds\": [\"xxxxx-xxxxxx-xxxxxx-xxxxx\"]\n}"},{"id":"039e62a4-5283-4753-aab6-d25c806531c2","name":"Commercial Extended","originalRequest":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"source_site\": \"Your lead Gen\",\r\n \"source_site_url\": \"https://your-lead-gen.nl\",\r\n \"contact\": {\r\n \"first_name\": \"Johnny\",\r\n \"last_name\": \"Doe\",\r\n \"email\": \"test@domain.com\",\r\n \"phone_number\": \"1234567789\",\r\n \"comments\": \"Comment..\",\r\n \"tags\": [1,2,3]\r\n },\r\n \"company\": {\r\n \"name\": \"Test company\",\r\n \"email\": \"test-company@company.nl\",\r\n \"kvk\": \"123123\",\r\n \"tax\": \"NL123123123\",\r\n \"phone_number\": \"1231231231\",\r\n \"tags\": [1,2,3]\r\n },\r\n \"address\": {\r\n \"zip\": \"7421ZA\",\r\n \"house_number\": \"5\"\r\n },\r\n \"projects\": [\r\n {\r\n \"status\": 1,\r\n \"type\": 1,\r\n \"account_manager\": \"user_123123123\",\r\n \"comments\": \"This is a comment\",\r\n \"custom_fields\": {\r\n \"1\": \"I dont know my description\",\r\n \"2\": \"04-06-1997\",\r\n \"3\": \"false\"\r\n },\r\n \"tags\": [1,2,3]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"successfulProjectCount\": 1,\n \"failedProjectCount\": 0,\n \"successfulProjectIds\": [\"xxxxx-xxxxxx-xxxxxx-xxxxx\"]\n}"},{"id":"64fe1fc6-9b41-4e85-b564-b0b78a321f1d","name":"Residential","originalRequest":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"source_site\": \"Your lead Gen\",\r\n \"source_site_url\": \"https://your-lead-gen.nl\",\r\n \"contact\": {\r\n \"first_name\": \"Johnny\",\r\n \"last_name\": \"Doe\",\r\n \"email\": \"test-account@yourdomain.nl\",\r\n \"phone_number\": \"1234567789\",\r\n \"comments\": \"Comment..\"\r\n },\r\n \"address\": {\r\n \"zip\": \"7421ZA\",\r\n \"house_number\": \"5\"\r\n },\r\n \"projects\": [\r\n {\r\n \"status\": 1,\r\n \"type\": 1,\r\n \"comments\": \"THIS IS A COMMENT\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"successfulProjectCount\": 1,\n \"failedProjectCount\": 0,\n \"successfulProjectIds\": [\"xxxxx-xxxxxx-xxxxxx-xxxxx\"]\n}"},{"id":"e071d15b-625c-4b1a-97b6-3517cbd1a943","name":"Residential Extended","originalRequest":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"source_site\": \"Your lead Gen\",\r\n \"source_site_url\": \"https://your-lead-gen.nl\",\r\n \"contact\": {\r\n \"first_name\": \"Johnny\",\r\n \"last_name\": \"Doe\",\r\n \"email\": \"test@domain.com\",\r\n \"phone_number\": \"1234567789\",\r\n \"comments\": \"Comment..\",\r\n \"tags\": [1,2,3]\r\n },\r\n \"address\": {\r\n \"zip\": \"7421ZA\",\r\n \"house_number\": \"5\",\r\n \"street_name\": \"Maagdenburgstraat\",\r\n \"country\": \"NL\",\r\n \"city\": \"Deventer\",\r\n \"state\": \"Overijssel\",\r\n \"lat\": 55.333333,\r\n \"lng\": 6.44444\r\n },\r\n \"projects\": [\r\n {\r\n \"status\": 1,\r\n \"type\": 1,\r\n \"account_manager\": \"user_123123123\",\r\n \"comments\": \"THIS IS A COMMENT\",\r\n \"custom_fields\": {\r\n \"1\": \"I dont know my description\",\r\n \"2\": \"04-06-1997\",\r\n \"3\": \"false\"\r\n },\r\n \"tags\": [1,2,3]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"successfulProjectCount\": 1,\n \"failedProjectCount\": 0,\n \"successfulProjectIds\": [\"xxxxx-xxxxxx-xxxxxx-xxxxx\"]\n}"},{"id":"aa7de998-6ee8-440a-8dd3-885b362a87c3","name":"All fields","originalRequest":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"source_site\": \"Your lead Gen\",\r\n \"source_site_url\": \"https://your-lead-gen.nl\",\r\n \"company\": {\r\n \"name\": \"Test\",\r\n \"kvk\": \"123123\",\r\n \"tax\": \"NL123123\",\r\n \"email\": \"test@test.nl\",\r\n \"phone_number\": \"123123123\",\r\n \"tags\": [1,2,3]\r\n },\r\n \"contact\": {\r\n \"first_name\": \"Johnny\",\r\n \"last_name\": \"Doe\",\r\n \"email\": \"test@domain.com\",\r\n \"phone_number\": \"1234567789\",\r\n \"comments\": \"Comment..\",\r\n \"tags\": [1,2,3]\r\n },\r\n \"address\": {\r\n \"zip\": \"7421ZA\",\r\n \"house_number\": \"5\",\r\n \"street_name\": \"Maagdenburgstraat\",\r\n \"country\": \"NL\",\r\n \"city\": \"Deventer\",\r\n \"state\": \"Overijssel\",\r\n \"lat\": 55.333333,\r\n \"lng\": 6.44444\r\n },\r\n \"projects\": [\r\n {\r\n \"status\": 1,\r\n \"type\": 1,\r\n \"group\": 1,\r\n \"account_manager\": \"user_123123123\",\r\n \"comments\": \"HII\",\r\n \"custom_fields\": {\r\n \"1\": \"I dont know my description\",\r\n \"2\": \"04-06-1997\",\r\n \"3\": \"false\"\r\n },\r\n \"tags\": [1,2,3]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"successfulProjectCount\": 1,\n \"failedProjectCount\": 0,\n \"successfulProjectIds\": [\"xxxxx-xxxxxx-xxxxxx-xxxxx\"]\n}"},{"id":"ba063120-80f0-4e9d-8f66-3b9344a81862","name":"Commercial Minimal","originalRequest":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"company\": {\r\n \"name\": \"Test company\"\r\n },\r\n \"projects\": [\r\n {\r\n \"status\": 1,\r\n \"type\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3","description":"The body below contains all possible fields in the API. Please use the example request button switcher to see different formats. (E.g. residential / commercial)"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"successfulProjectCount\": 1,\n \"failedProjectCount\": 0,\n \"successfulProjectIds\": [\"xxxxx-xxxxxx-xxxxxx-xxxxx\"]\n}"},{"id":"22d9ccc2-db7f-4563-a1bb-cd0c6db79414","name":"Residential Minimal","originalRequest":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"contact\": {\r\n \"first_name\": \"Johnny\",\r\n \"last_name\": \"Doe\",\r\n \"email\": \"test-account@yourdomain.nl\"\r\n },\r\n \"projects\": [\r\n {\r\n \"status\": 1,\r\n \"type\": 1\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3","description":"The body below contains all possible fields in the API. Please use the example request button switcher to see different formats. (E.g. residential / commercial)"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":null,"cookie":[],"responseTime":null,"body":"{\n \"successfulProjectCount\": 1,\n \"failedProjectCount\": 0,\n \"successfulProjectIds\": [\"xxxxx-xxxxxx-xxxxxx-xxxxx\"]\n}"}],"_postman_id":"d3341c1a-6212-4b97-8ad7-f384aa602c01"},{"name":"Create project note","id":"64176e6b-4479-4c53-b918-254e23c15efe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"note\": {\n \"content\": {\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"text\": \"{{TEXT HERE}}\",\n \"type\": \"text\"\n }\n ]\n }\n // ,{\n // \"type\": \"paragraph\",\n // \"content\": [\n // {\n // \"text\": \"{{PARAGRAPH 2 HERE}}\",\n // \"type\": \"text\"\n // }\n // ]\n // }\n // ,{\n // \"type\": \"paragraph\",\n // \"content\": [\n // {\n // \"text\": \"{{PARAGRAPH 3 HERE}}\",\n // \"type\": \"text\"\n // }\n // ]\n // }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3/{{id}}/note","urlObject":{"protocol":"https","path":["api","project","v3","{{id}}","note"],"host":["app","opusflow","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"64176e6b-4479-4c53-b918-254e23c15efe"},{"name":"Change project status","id":"7352b6d1-8cee-4f26-b532-e50fa0dbd9c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": {{STATUS_ID}} // The new status ID of the project\n}","options":{"raw":{"language":"json"}}},"url":"https://app.opusflow.io/api/project/v3/{{id}}/status","urlObject":{"protocol":"https","path":["api","project","v3","{{id}}","status"],"host":["app","opusflow","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"7352b6d1-8cee-4f26-b532-e50fa0dbd9c2"},{"name":"Get project","id":"812254a5-ceb9-44cb-963d-7839915235df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org_id","value":"{{org_id}}","type":"text"},{"key":"secret","value":"{{secret}}","type":"text"}],"url":"https://app.opusflow.io/api/project/v3/{{id}}","urlObject":{"protocol":"https","path":["api","project","v3","{{id}}"],"host":["app","opusflow","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"812254a5-ceb9-44cb-963d-7839915235df"}],"event":[{"listen":"prerequest","script":{"id":"f86d85b2-8550-4f39-bc43-82f7c25c219c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c9c745fe-eada-4b11-8293-eaf1b681a3f6","type":"text/javascript","exec":[""]}}]}