When creating a contact, the following fields are required;
\nThis endpoint is used to update an existing contact.
\nWhen updating a contact, the following fields are required;
\nThis endpoint is used to delete an existing contact. It takes in a path param for the contact that you need to delete.
\n","urlObject":{"path":["v1","contact",":contactId","delete"],"host":["https://dev.monkeypesa.com/contact/api/external"],"query":[],"variable":[{"description":{"content":"This is the Id of the contact you want to delete
\n","type":"text/plain"},"type":"any","value":"8a8082168460c81501846c14fe32001e","key":"contactId"}]}},"response":[{"id":"3fd7f7d3-2f96-4f41-9b9d-d9b273199954","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{API_TOKEN}}","type":"text"},{"key":"organization-id","value":"MP-2021-11","type":"text"}],"url":{"raw":"https://dashboard.monkeypesa.com{{CONTACTS_MICRO_SERVICE_ENDPOINT_PATH}}/v1/contact/:contactId/delete","protocol":"https","host":["dashboard","monkeypesa","com{{CONTACTS_MICRO_SERVICE_ENDPOINT_PATH}}"],"path":["v1","contact",":contactId","delete"],"variable":[{"key":"contactId","value":"8a8082168460c81501846c14fe32001e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 12 Nov 2022 14:04:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"authorization","value":"Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyNTY3NzIwMDAxNzAiLCJleHAiOjE2Njk0MDU0NDMsImlhdCI6MTY2NjgxMzQ0MywiYXV0aG9yaXRpZXMiOlsiVmlldyBEaXN0cmljdHMiLCJwZXJtX3dlYl9hY2Nlc3MiLCJwZXJtX3dlYl9hY2Nlc3MiLCJWaWV3IExlYWRzIiwiVmlldyBMb29rIFVwcyIsInBlcm1fd2ViX2FjY2VzcyIsInBlcm1fd2ViX2FjY2VzcyIsIk1hbmFnZSBMZWFkcyIsInBlcm1fd2ViX2FjY2VzcyIsIk1hcmsgYWxsIG5vdGlmaWNhdGlvbnMgYXMgcmVhZCIsIk1hbmFnZSBWaWRlbyBNZWV0aW5ncyIsInBlcm1fd2ViX2FjY2VzcyIsIlZpZXcgQ29tcGFuaWVzIiwicGVybV93ZWJfYWNjZXNzIiwicGVybV93ZWJfYWNjZXNzIiwiTWFyayBzaW5nbGUgbm90aWZpY2F0aW9uIGFzIHJlYWQiLCJwZXJtX3dlYl9hY2Nlc3MiLCJWaWV3IFZpZGVvIE1lZXRpbmdzIiwicGVybV93ZWJfYWNjZXNzIiwiVmlldyBDb3VudHJpZXMiLCJNYW5hZ2UgQ3VzdG9tIEZpZWxkcyIsInBlcm1fd2ViX2FjY2VzcyIsInBlcm1fd2ViX2FjY2VzcyIsIk1hbmFnZSBSb2xlcyIsIk1hbmFnZSBMb29rIFVwcyIsInBlcm1fd2ViX2FjY2VzcyIsInBlcm1fd2ViX2FjY2VzcyIsIk1hbmFnZSBDdXJyZW5jaWVzIiwiVmlldyBSb2xlcyIsInBlcm1fd2ViX2FjY2VzcyIsInBlcm1fd2ViX2FjY2VzcyIsIk1hbmFnZSBQYXltZW50IE5vdGlmaWNhdGlvbnMiLCJWaWV3IENvbnRhY3RzIiwicGVybV93ZWJfYWNjZXNzIiwicGVybV93ZWJfYWNjZXNzIiwiTm9ybWFsIFVzZXIiLCJwZXJtX3dlYl9hY2Nlc3MiLCJNYW5hZ2UgQ29tcGFuaWVzIiwiVmlldyBub3RpZmljYXRpb25zIiwicGVybV93ZWJfYWNjZXNzIiwiTWFuYWdlIFVzZXJzIiwicGVybV93ZWJfYWNjZXNzIiwiVmlldyBMaXN0cyIsInBlcm1fd2ViX2FjY2VzcyIsInBlcm1fd2ViX2FjY2VzcyIsIlZpZXcgQ3VzdG9tIEZpZWxkcyIsInBlcm1fd2ViX2FjY2VzcyIsIk1hbmFnZSBMaXN0cyIsInBlcm1fd2ViX2FjY2VzcyIsIlZpZXcgQ3VycmVuY2llcyIsInBlcm1fd2ViX2FjY2VzcyIsInBlcm1fd2ViX2FjY2VzcyIsIk1hbmFnZSBEaXN0cmljdHMiLCJwZXJtX3dlYl9hY2Nlc3MiLCJNYW5hZ2UgQ29udGFjdHMiLCJWaWV3IFVzZXJzIiwicGVybV93ZWJfYWNjZXNzIiwiVmlldyBUaWNrZXRzIiwicGVybV93ZWJfYWNjZXNzIiwicGVybV93ZWJfYWNjZXNzIiwiVmlldyBQYXltZW50IE5vdGlmaWNhdGlvbnMiXX0.dkGtQOIZed6aJuyYsYqLOqeUNxryUrowYPwJNN_3W0A"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, OPTIONS"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, X-Requested-With, remember-me, Authorization,Cache-Control, organization-id"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"message\": \"Operation successful\"\n}"}],"_postman_id":"4b07b0ec-1086-4bae-8476-a7dc8b9ca928"},{"name":"Find By Id","id":"e85d20c2-ce3f-4594-90a8-10a4c39baf89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{your_organization_id}","type":"text"},{"key":"api-secret-key","value":"{your_api_secret_key}","type":"text"}],"url":"https://dev.monkeypesa.com/contact/api/external/v1/contact/:contactId","description":"This endpoint is used to fetch details of the provided contact id. It takes in a path param for the contact that you need to fetch.
\n","urlObject":{"path":["v1","contact",":contactId"],"host":["https://dev.monkeypesa.com/contact/api/external"],"query":[],"variable":[{"description":{"content":"This is the Id of the contact you want to fetch
\n","type":"text/plain"},"type":"any","value":"4028810486891af101868922dfb30002","key":"contactId"}]}},"response":[{"id":"b14373d9-7432-4c1d-9ffd-372be8ab15e5","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{your_organization_id}","type":"text"},{"key":"api-secret-key","value":"{your_api_secret_key}","type":"text"}],"url":{"raw":"https://dev.monkeypesa.com/contact/api/external/v1/contact/:contactId","host":["https://dev.monkeypesa.com/contact/api/external"],"path":["v1","contact",":contactId"],"variable":[{"key":"contactId","value":"4028810486891af101868922dfb30002"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, OPTIONS"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, X-Requested-With, remember-me, Authorization,Cache-Control, organization-id"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sat, 25 Feb 2023 15:16:10 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"message\": \"Operation successful\",\n \"recordStatus\": \"ACTIVE\",\n \"dateCreated\": \"2023-02-25T15:13:29.301Z\",\n \"dateChanged\": \"2023-02-25T15:15:23.340Z\",\n \"changedByFullName\": \"Ben Uther\",\n \"changedByEmail\": \"benuther203@gmail.com\",\n \"id\": \"4028810486891af101868922dfb30002\",\n \"firstName\": \"Ben\",\n \"lastName\": \"Uther\",\n \"title\": \"Mr.\",\n \"emailAddress\": \"benuther20+1@gmail.com\",\n \"companyName\": \"MonkeyPesa (U) Ltd\",\n \"description\": \"My description of this contact\",\n \"howYouFoundUs\": \"GOOGLE_SEARCH\",\n \"foundUsDetails\": \"Any additional details\",\n \"countryName\": \"MonkeyPesa (U) Ltd\",\n \"contactType\": \"CONTACT\"\n}"},{"id":"9fe3ffa4-497c-4e34-ab71-f94d61f1f91c","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{your_organization_id}","type":"text"},{"key":"api-secret-key","value":"{your_api_secret_key}","type":"text"}],"url":{"raw":"https://dev.monkeypesa.com/contact/api/external/v1/contact/:contactId","host":["https://dev.monkeypesa.com/contact/api/external"],"path":["v1","contact",":contactId"],"variable":[{"key":"contactId","value":"4028810486891af101868922dfb30002p"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sat, 25 Feb 2023 15:16:24 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"message\": \"No contact found with the provided Id [4028810486891af101868922dfb30002p]\"\n}"}],"_postman_id":"e85d20c2-ce3f-4594-90a8-10a4c39baf89"},{"name":"Find Contacts","id":"e50a20a5-1405-4576-8dfc-97b1c30ea5d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{your_organization_id}","type":"text"},{"key":"api-secret-key","value":"{your_api_secret_key}","type":"text"}],"url":"https://dev.monkeypesa.com/contact/api/external/v1/contacts?offset=0&limit=100&searchTerm","description":"This endpoint is used to get a paginated list of contacts from the provided offset and limit.
\nThis also includes a search term that is used to make textual search for all columns on the database.
\n","urlObject":{"path":["v1","contacts"],"host":["https://dev.monkeypesa.com/contact/api/external"],"query":[{"description":{"content":"List offset
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Resultset limit
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"Textual fields search terms
\n","type":"text/plain"},"key":"searchTerm","value":null}],"variable":[]}},"response":[{"id":"97bacf3c-1d7c-4212-9ecd-459ba762f266","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{your_organization_id}","type":"text"},{"key":"api-secret-key","value":"{your_api_secret_key}","type":"text"}],"url":{"raw":"https://dev.monkeypesa.com/contact/api/external/v1/contacts?offset=0&limit=100&searchTerm&showRecords=true","host":["https://dev.monkeypesa.com/contact/api/external"],"path":["v1","contacts"],"query":[{"key":"offset","value":"0","description":"List offset"},{"key":"limit","value":"100","description":"Resultset limit"},{"key":"searchTerm","value":null,"description":"Textual fields search terms"},{"key":"showRecords","value":"true","description":"This can be true or false. If this is false, only the record count is returned"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, OPTIONS"},{"key":"Access-Control-Request-Method","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, X-Requested-With, remember-me, Authorization,Cache-Control, organization-id"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Sat, 25 Feb 2023 15:17:00 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"totalItems\": 1,\n \"records\": [\n {\n \"recordStatus\": \"ACTIVE\",\n \"dateCreated\": \"2023-02-25T15:13:29.301Z\",\n \"dateChanged\": \"2023-02-25T15:15:23.340Z\",\n \"changedByFullName\": \"Ben Uther\",\n \"changedByEmail\": \"benuther203@gmail.com\",\n \"id\": \"4028810486891af101868922dfb30002\",\n \"firstName\": \"Ben\",\n \"lastName\": \"Uther\",\n \"title\": \"Mr.\",\n \"emailAddress\": \"benuther20+1@gmail.com\",\n \"companyName\": \"MonkeyPesa (U) Ltd\",\n \"description\": \"My description of this contact\",\n \"howYouFoundUs\": \"GOOGLE_SEARCH\",\n \"foundUsDetails\": \"Any additional details\",\n \"countryName\": \"MonkeyPesa (U) Ltd\",\n \"contactType\": \"CONTACT\"\n }\n ],\n \"totalPages\": 1,\n \"message\": \"Operation successful\",\n \"currentPage\": 0,\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"e50a20a5-1405-4576-8dfc-97b1c30ea5d2"}],"id":"4bb37c39-f213-46d7-b542-5703252c5ce0","_postman_id":"4bb37c39-f213-46d7-b542-5703252c5ce0","description":""}],"event":[{"listen":"prerequest","script":{"id":"dd908ac5-24e7-42e4-9f92-f1029cc009ff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"636760d8-78b0-45dd-8e79-c0aa397bd651","type":"text/javascript","exec":[""]}}],"variable":[{"key":"HOST_URL","value":"https://dev.monkeypesa.com","type":"string"},{"key":"CONTACTS_SERVICE_ENDPOINT_PATH","value":"/contact/api/external","type":"string"},{"key":"ORGANIZATION_ID","value":"{your_organization_id}","type":"string"},{"key":"API_SECRET_KEY","value":"{your_api_secret_key}","type":"string"}]}