{ "opencollection": "1.0.0", "info": { "name": "Hilos Contact API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Contact", "type": "folder" }, "items": [ { "info": { "name": "List contacts", "type": "http" }, "http": { "method": "GET", "url": "https://api.hilos.io/api/contact", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "search", "value": "", "type": "query", "description": "You can search with the base `phone`, `first_name`, `last_name`, `email` and `external_url` fields." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists contacts." }, { "info": { "name": "Create a contact", "type": "http" }, "http": { "method": "POST", "url": "https://api.hilos.io/api/contact", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "When you POST a new Contact, we'll first check if another contact exists with the same phone. If it does, we'll do a partial update to the existing contact with this new information. We do this so you don't end up with duplicate contacts in your account. \n\nYou can set arbitrary attributes for a contact in the meta object, using `meta={custom_property_1: 'some value', another_property: 'another value ...', ...}`. We parse all these attributes as strings for now. \n\n We append the received `meta`, " }, { "info": { "name": "Get Contact", "type": "http" }, "http": { "method": "GET", "url": "https://api.hilos.io/api/contact/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets a Contact by Id." }, { "info": { "name": "Update Contact", "type": "http" }, "http": { "method": "PUT", "url": "https://api.hilos.io/api/contact/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a Contact. \n\n If you send a empty `meta` or `tags` the contact will have those properties removed." }, { "info": { "name": "Partially Update Contact", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.hilos.io/api/contact/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Update a Contact sending only the properties you want to update. \n\n If you send the `meta` or `tags` the contact will have those properties appended with the contact current ones." }, { "info": { "name": "Delete Contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hilos.io/api/contact/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deleting a contact won't delete its history nor its sent messages." } ] } ], "bundled": true }