The following APIs provide extensive functionality for reading, creating and updating entities associated to PeatQL's Case Management system. Leverage them to bring in Case Management functionality into the applications you are building.
\nDo reach out to our team if you find any issues, or have feature requests!
\nContact our team at:
Name: kale
Email: kale@obp.com
(Required) ID of case to return
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"121e0eea-b886-4dce-9702-c93283189863","name":"successful operation","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.obp.com/case/:id","host":["https://api.obp.com"],"path":["case",":id"],"variable":[{"key":"id","value":"id esse exercitation officia","description":"(Required) ID of case to return"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"Duis sint nostrud\"\n}"},{"id":"76100ffa-44bb-4e04-a70d-2d9ad13c79c3","name":"Invalid ID supplied","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.obp.com/case/:id","host":["https://api.obp.com"],"path":["case",":id"],"variable":[{"key":"id","value":"id esse exercitation officia","description":"(Required) ID of case to return"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"5b570208-31c6-4f45-840e-b460b0d5eb6e","name":"Case not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.obp.com/case/:id","host":["https://api.obp.com"],"path":["case",":id"],"variable":[{"key":"id","value":"id esse exercitation officia","description":"(Required) ID of case to return"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4ee2fe08-ff5e-4dd0-b737-1cffcccb53b9"},{"name":"Delete support case","id":"5b2c486b-d3a2-4dc1-a15d-c69ec830d474","request":{"method":"DELETE","header":[],"url":"https://api.obp.com/case/:id","urlObject":{"path":["case",":id"],"host":["https://api.obp.com"],"query":[],"variable":[{"description":{"content":"(Required) Case id to delete
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"fb9f945d-4e35-4039-ac1f-2c7cb2723304","name":"ok","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.obp.com/case/:id","host":["https://api.obp.com"],"path":["case",":id"],"variable":[{"key":"id","value":"id esse exercitation officia","description":"(Required) Case id to delete"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"0f6d36c3-c226-490a-8e8f-0b0730f10025","name":"Invalid ID supplied","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.obp.com/case/:id","host":["https://api.obp.com"],"path":["case",":id"],"variable":[{"key":"id","value":"id esse exercitation officia","description":"(Required) Case id to delete"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"77d56ab6-d902-48e1-af71-d4eb2c590a92","name":"Case not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.obp.com/case/:id","host":["https://api.obp.com"],"path":["case",":id"],"variable":[{"key":"id","value":"id esse exercitation officia","description":"(Required) Case id to delete"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5b2c486b-d3a2-4dc1-a15d-c69ec830d474"}],"id":"0271601c-2847-414e-a304-cf4832674b5e","_postman_id":"0271601c-2847-414e-a304-cf4832674b5e","description":""},{"name":"Create support case","id":"85b45573-4527-4cff-9e37-62f494839a30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"PENDING\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/case","urlObject":{"path":["case"],"host":["https://api.obp.com"],"query":[],"variable":[]}},"response":[{"id":"dfa6adc1-985c-4f89-9f01-b5d300354312","name":"ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"Duis sint nostrud\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/case"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"0de8577f-cffa-44ce-8f45-e3a29ea1b4ce","name":"Invalid input","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"Duis sint nostrud\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/case"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"85b45573-4527-4cff-9e37-62f494839a30"},{"name":"Update support case","id":"3bbd7eb0-9fda-4da9-b6e1-d2ae5286ba5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"IN PROGRESS\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/case","urlObject":{"path":["case"],"host":["https://api.obp.com"],"query":[],"variable":[]}},"response":[{"id":"5bebcb5b-dd84-4b2c-b34b-bc9025d374d5","name":"ok","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"Duis sint nostrud\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/case"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"ae2d4c74-0203-4cb1-b92a-ce8268e58f53","name":"Invalid ID supplied","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"Duis sint nostrud\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/case"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a344f54a-0f9a-4eeb-8cf5-54e7fdf4769e","name":"Case not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"Duis sint nostrud\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/case"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"fb607a65-ade1-4d81-80b4-8bdefb3713c6","name":"Validation exception","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"CD-5\",\n \"contact_email\": \"eeshan@obp.com\",\n \"summary\": \"Cross-Origin Resource Sharing Misconfiguration\",\n \"priority\": \"High\",\n \"status\": \"Duis sint nostrud\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/case"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3bbd7eb0-9fda-4da9-b6e1-d2ae5286ba5c"}],"id":"135ef3dd-83b1-4a5a-810d-d373b1c01da1","description":"Manage PeatQL Support Cases via a comprehensive set of APIs.
\n","_postman_id":"135ef3dd-83b1-4a5a-810d-d373b1c01da1"},{"name":"Messages","item":[{"name":"Read message by ID","id":"c7d60d7a-f13c-45f4-bd45-2bb1850f8a31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.obp.com/message/:id","urlObject":{"path":["message",":id"],"host":["https://api.obp.com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the message to retrieve
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"c7d60d7a-f13c-45f4-bd45-2bb1850f8a31"},{"name":"Get Messages by Case","id":"90b7638c-8292-4c67-95a4-0c44b19958c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.obp.com/messages?caseId","urlObject":{"path":["messages"],"host":["https://api.obp.com"],"query":[{"description":{"content":"(Required) The case ID of associated Messages to retrieve
\n","type":"text/plain"},"key":"caseId","value":null}],"variable":[]}},"response":[],"_postman_id":"90b7638c-8292-4c67-95a4-0c44b19958c4"},{"name":"Delete Messages for Case","id":"2de466c4-9a59-44de-b68c-41fadabddcaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.obp.com/messages?caseId","urlObject":{"path":["messages"],"host":["https://api.obp.com"],"query":[{"description":{"content":"(Required) The ID of the Case to delete
\n","type":"text/plain"},"key":"caseId","value":null}],"variable":[]}},"response":[],"_postman_id":"2de466c4-9a59-44de-b68c-41fadabddcaf"},{"name":"Update Message by ID","id":"a2935218-1a8c-4a0d-87ca-904a771fe9fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"M-23929\",\n \"case_id\": \"CD-2324\",\n \"content\": \"Need assistance urgently\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/messages/:id","urlObject":{"path":["messages",":id"],"host":["https://api.obp.com"],"query":[],"variable":[{"description":{"content":"(Required) The ID of the Message to update
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"a2935218-1a8c-4a0d-87ca-904a771fe9fc"},{"name":"Create Message on Case","id":"2632bc53-9ab2-4a37-98fe-bdd581bba6c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"content\": \"Need assistance urgently\",\n \"author\": \"daniel@obp.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/messages?caseId","urlObject":{"path":["messages"],"host":["https://api.obp.com"],"query":[{"description":{"content":"The Case ID
\n","type":"text/plain"},"key":"caseId","value":null}],"variable":[]}},"response":[],"_postman_id":"2632bc53-9ab2-4a37-98fe-bdd581bba6c5"}],"id":"18e8f608-77ef-4258-9a21-3d9d561309d6","_postman_id":"18e8f608-77ef-4258-9a21-3d9d561309d6","description":""},{"name":"Profiles","item":[{"name":"Create Profile in Case","id":"f3c840be-c0d1-4768-8d5a-73dce88efe80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"profile_id\": \"P-33333\",\n \"email\": \"external-customer@example.co\",\n \"first_name\": \"Daniel\",\n \"last_name\": \"Wong\",\n \"company\": \"Example Company Co.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/profiles?caseId","urlObject":{"path":["profiles"],"host":["https://api.obp.com"],"query":[{"description":{"content":"The Case ID
\n","type":"text/plain"},"key":"caseId","value":null}],"variable":[]}},"response":[],"_postman_id":"f3c840be-c0d1-4768-8d5a-73dce88efe80"},{"name":"Get Profile by ID","id":"b9037b90-396d-4573-8c73-af8b91b5b5ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.obp.com/profiles/:id","urlObject":{"path":["profiles",":id"],"host":["https://api.obp.com"],"query":[],"variable":[{"description":{"content":"The Profile ID
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"b9037b90-396d-4573-8c73-af8b91b5b5ee"},{"name":"Get Profiles by Email","id":"18d9cbda-2db4-4278-9719-e82121e4752d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.obp.com/profiles?email=","urlObject":{"path":["profiles"],"host":["https://api.obp.com"],"query":[{"description":{"content":"The email address of the profile
\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[],"_postman_id":"18d9cbda-2db4-4278-9719-e82121e4752d"},{"name":"Get Profiles by Case","id":"fd228a5d-02ae-43a5-b2b1-46a737cc77d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.obp.com/profiles?caseId","urlObject":{"path":["profiles"],"host":["https://api.obp.com"],"query":[{"description":{"content":"The case ID
\n","type":"text/plain"},"key":"caseId","value":null}],"variable":[]}},"response":[],"_postman_id":"fd228a5d-02ae-43a5-b2b1-46a737cc77d1"},{"name":"Update Profile By ID","id":"6aef9038-e543-44ba-9d31-e4fdae622b96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"external-customer@example.co\",\n \"first_name\": \"Daniel\",\n \"last_name\": \"Wong\",\n \"company\": \"Example Company Co.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.obp.com/profiles/:id","urlObject":{"path":["profiles",":id"],"host":["https://api.obp.com"],"query":[],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"6aef9038-e543-44ba-9d31-e4fdae622b96"}],"id":"c77c7539-6c9e-4e9d-9c34-822b89b338d7","_postman_id":"c77c7539-6c9e-4e9d-9c34-822b89b338d7","description":""},{"name":"Search","item":[{"name":"Search Messages","id":"0098b906-9b35-47e3-8e0a-c1229b7309ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.obp.com/messages?filter","urlObject":{"path":["messages"],"host":["https://api.obp.com"],"query":[{"description":{"content":"A set of filters, specified in JSON format
\n","type":"text/plain"},"key":"filter","value":null}],"variable":[]}},"response":[],"_postman_id":"0098b906-9b35-47e3-8e0a-c1229b7309ed"},{"name":"Search Cases","id":"0229ef34-f2dc-4c57-92e7-df242fd3f01c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.obp.com/cases?filter","urlObject":{"path":["cases"],"host":["https://api.obp.com"],"query":[{"description":{"content":"A set of filters, specified in JSON format
\n","type":"text/plain"},"key":"filter","value":null}],"variable":[]}},"response":[],"_postman_id":"0229ef34-f2dc-4c57-92e7-df242fd3f01c"},{"name":"Search Profiles","id":"2a6d5fac-3229-44a0-8786-90725209c811","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.obp.com/profiles?filter","urlObject":{"path":["profiles"],"host":["https://api.obp.com"],"query":[{"description":{"content":"A set of filters, specified in JSON format
\n","type":"text/plain"},"key":"filter","value":null}],"variable":[]}},"response":[],"_postman_id":"2a6d5fac-3229-44a0-8786-90725209c811"}],"id":"e3cd5a58-4125-430b-8f85-4a074f29d06b","_postman_id":"e3cd5a58-4125-430b-8f85-4a074f29d06b","description":""}],"variable":[{"id":"affc3510-9672-4493-975d-f3e8942e139c","key":"baseUrl","value":"https://api.obp.com","type":"string"}]}