{"id":5142,"date":"2017-09-29T09:51:36","date_gmt":"2017-09-29T07:51:36","guid":{"rendered":"https:\/\/www.minicrm.hu\/help\/?p=5142"},"modified":"2017-11-13T11:07:24","modified_gmt":"2017-11-13T10:07:24","slug":"contact-actions","status":"publish","type":"post","link":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/","title":{"rendered":"Contact actions"},"content":{"rendered":"

Companies and contact persons<\/a> stored in MiniCRM are displayed as a Contact in case of API<\/a>.<\/strong><\/p>\n

Contact<\/a>\u00a0search (field-based)<\/h3>\n

Identification is required, example url:<\/p>\n

$ curl https:\/\/SystemId:APIKey@r3.minicrm.hu\/Api\/R3\/Contact?Email=jd@example.com<\/code><\/pre>\n
It is possible to search the values of fields. The search applies to those fields as well that cannot be seen among the results of the search. For further information, go to the Database Schema<\/a>\u00a0<\/strong>section. If you would like to filter in a more detailed way, you can add more fields as a parameter, for example:<\/p>\n
$ curl https:\/\/SystemId:APIKey@r3.minicrm.hu\/Api\/R3\/Contact?Email=kjozsef@teszt.hu&Type=Person\r\n<\/code><\/pre>\n
Example output:<\/strong><\/p>\n
{\r\n  \"Count\": 1,\r\n  \"Results\": {\r\n    \"12345\": {\r\n      \"Id\": \"12345\",\r\n      \"Name\": \"John Doe\",\r\n      \"Url\": \"https:\/\/r3.minicrm.hu\/Api\/R3\/Contact\/12345\",\r\n      \"Type\": \"Person\",\r\n      \"Email\": \"jd@example.com\",\r\n      \"Phone\": \"0612345678\"\r\n    }\r\n  }\r\n}<\/code><\/pre>\n
You can search among contacts<\/a>.<\/h3>\n
Contact<\/a>\u00a0<\/strong>(GET)<\/h3>\n
Identification is required,\u00a0example url:<\/p>\n
$ curl https:\/\/SystemId:APIKey@r3.minicrm.hu\/Api\/R3\/Contact\/12346<\/code><\/pre>\n
Get all data of a given contact.<\/p>\n
In the response, the contact is received in one\u00a0array, in which you can see the data of the contact\u00a0fields.<\/p>\n
Example output (Company)<\/strong><\/p>\n
{\r\n  \"Id\": 12346,\r\n  \"Type\": \"Business\",\r\n  \"Name\": \"Test Business\",\r\n  \"Email\": \"info@test.com\",\r\n  \"EmailType\": \"\",\r\n  \"Phone\": \"06-1 \/ 987-65432\",\r\n  \"PhoneType\": \"\",\r\n  \"Description\": \"\",\r\n  \"Url\": \"http:\/\/test.com\",\r\n  \"Industry\": \"\",\r\n  \"Region\": \"\",\r\n  \"VatNumber\": \"\",\r\n  \"RegistrationNumber\": \"\",\r\n  \"BankAccount\": \"12345678-12345678-12345678\",\r\n  \"Swift\": \"\",\r\n  \"Employees\": 0,\r\n  \"YearlyRevenue\": 0\r\n}<\/code><\/pre>\n
Example output (Person)<\/strong><\/p>\n
{\r\n  \"Id\": 12345,\r\n  \"BusinessId\": 12346,\r\n  \"Type\": \"Person\",\r\n  \"FirstName\": \"John\",\r\n  \"LastName\": \"Doe\",\r\n  \"Email\": \"jd@example.com\",\r\n  \"EmailType\": \"\",\r\n  \"Phone\": \"0612345678\",\r\n  \"PhoneType\": \"\",\r\n  \"Position\": \"IT\"\r\n}<\/code><\/pre>\n
Contact<\/a>\u00a0<\/strong>(PUT)<\/h3>\n
Modifying an existing contact, or creating a new one.\u00a0When modifying existing projects, it\u2019s better to send only the changed fields. Identification is required, example url:<\/p>\n
$ curl -XPUT https:\/\/SystemId:APIKey@r3.minicrm.hu\/Api\/R3\/Contact\/12345 -d '{\r\n \"FirstName\":\"John\",\r\n \"LastName\":\"Doe\"\r\n}'<\/code><\/pre>\n
The service URL equals to the URL of contact download. You can download a contact with\u00a0GET\u00a0request, and with PUT request, you can modify data. It is possible to add a new contact by omitting the ID (12345 at the end of example\u00a0url). It is important that in case of a new contact, it is required to send the Type field, and in case of an existing task, the Type field cannot be edited. To assign a person to a company<\/a>, enter the company’s ID into the BusinessID field.<\/p>\n
The data structure expected by\u00a0input\u00a0is the same as the structure received by the download of the contact.\u00a0Input\u00a0format is JSON serialized array.<\/p>\n
Example output:<\/strong><\/p>\n
{\r\n  \"Id\":12345\r\n}<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
Companies and contact persons stored in MiniCRM are displayed as a Contact in case of API. Contact\u00a0search (field-based) Identification is required, example url: $ curl https:\/\/SystemId:APIKey@r3.minicrm.hu\/Api\/R3\/Contact?Email=jd@example.com It is possible to search the values of fields. The search applies to those fields as well that cannot be seen among the results of the search. For further […]<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[387],"tags":[422],"class_list":["post-5142","post","type-post","status-publish","format-standard","hentry","category-more-developers","tag-api-en"],"yoast_head":"\nContact actions - Documenta\u021bie MiniCRM<\/title>\n<meta name=\"description\" content=\"Companies and contact persons stored in MiniCRM are displayed as a Contact in case of API. Contact\u00a0search (field-based) Identification is required,\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Contact actions - Documenta\u021bie MiniCRM\" \/>\n<meta property=\"og:description\" content=\"Companies and contact persons stored in MiniCRM are displayed as a Contact in case of API. Contact\u00a0search (field-based) Identification is required,\" \/>\n<meta property=\"og:url\" content=\"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/\" \/>\n<meta property=\"og:site_name\" content=\"Documenta\u021bie MiniCRM\" \/>\n<meta property=\"article:published_time\" content=\"2017-09-29T07:51:36+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2017-11-13T10:07:24+00:00\" \/>\n<meta name=\"author\" content=\"L\u00edvia F\u00fcl\u00f6p\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"L\u00edvia F\u00fcl\u00f6p\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/\"},\"author\":{\"name\":\"L\u00edvia F\u00fcl\u00f6p\",\"@id\":\"https:\\\/\\\/www.minicrm.hu\\\/help\\\/#\\\/schema\\\/person\\\/8fabeab95ca44349ab8963bd5a41e3d7\"},\"headline\":\"Contact actions\",\"datePublished\":\"2017-09-29T07:51:36+00:00\",\"dateModified\":\"2017-11-13T10:07:24+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/\"},\"wordCount\":278,\"commentCount\":0,\"keywords\":[\"api-en\"],\"articleSection\":[\"More Developers\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/\",\"url\":\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/\",\"name\":\"Contact actions - Documenta\u021bie MiniCRM\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.minicrm.hu\\\/help\\\/#website\"},\"datePublished\":\"2017-09-29T07:51:36+00:00\",\"dateModified\":\"2017-11-13T10:07:24+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/www.minicrm.hu\\\/help\\\/#\\\/schema\\\/person\\\/8fabeab95ca44349ab8963bd5a41e3d7\"},\"description\":\"Companies and contact persons stored in MiniCRM are displayed as a Contact in case of API. Contact\u00a0search (field-based) Identification is required,\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/helpdev.minicrm.io\\\/help\\\/contact-actions\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.minicrm.hu\\\/help\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Contact actions\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.minicrm.hu\\\/help\\\/#website\",\"url\":\"https:\\\/\\\/www.minicrm.hu\\\/help\\\/\",\"name\":\"Documenta\u021bie MiniCRM\",\"description\":\"Welcome to MiniCRM\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.minicrm.hu\\\/help\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/www.minicrm.hu\\\/help\\\/#\\\/schema\\\/person\\\/8fabeab95ca44349ab8963bd5a41e3d7\",\"name\":\"L\u00edvia F\u00fcl\u00f6p\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/f3134b1be47aa2326a775dd7090fd53fb8a694a561ad9cc5ec8f1e66ff8bacc4?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/f3134b1be47aa2326a775dd7090fd53fb8a694a561ad9cc5ec8f1e66ff8bacc4?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/f3134b1be47aa2326a775dd7090fd53fb8a694a561ad9cc5ec8f1e66ff8bacc4?s=96&d=mm&r=g\",\"caption\":\"L\u00edvia F\u00fcl\u00f6p\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Contact actions - Documenta\u021bie MiniCRM","description":"Companies and contact persons stored in MiniCRM are displayed as a Contact in case of API. Contact\u00a0search (field-based) Identification is required,","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/","og_locale":"en_US","og_type":"article","og_title":"Contact actions - Documenta\u021bie MiniCRM","og_description":"Companies and contact persons stored in MiniCRM are displayed as a Contact in case of API. Contact\u00a0search (field-based) Identification is required,","og_url":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/","og_site_name":"Documenta\u021bie MiniCRM","article_published_time":"2017-09-29T07:51:36+00:00","article_modified_time":"2017-11-13T10:07:24+00:00","author":"L\u00edvia F\u00fcl\u00f6p","twitter_card":"summary_large_image","twitter_misc":{"Written by":"L\u00edvia F\u00fcl\u00f6p","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/#article","isPartOf":{"@id":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/"},"author":{"name":"L\u00edvia F\u00fcl\u00f6p","@id":"https:\/\/www.minicrm.hu\/help\/#\/schema\/person\/8fabeab95ca44349ab8963bd5a41e3d7"},"headline":"Contact actions","datePublished":"2017-09-29T07:51:36+00:00","dateModified":"2017-11-13T10:07:24+00:00","mainEntityOfPage":{"@id":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/"},"wordCount":278,"commentCount":0,"keywords":["api-en"],"articleSection":["More Developers"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/helpdev.minicrm.io\/help\/contact-actions\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/","url":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/","name":"Contact actions - Documenta\u021bie MiniCRM","isPartOf":{"@id":"https:\/\/www.minicrm.hu\/help\/#website"},"datePublished":"2017-09-29T07:51:36+00:00","dateModified":"2017-11-13T10:07:24+00:00","author":{"@id":"https:\/\/www.minicrm.hu\/help\/#\/schema\/person\/8fabeab95ca44349ab8963bd5a41e3d7"},"description":"Companies and contact persons stored in MiniCRM are displayed as a Contact in case of API. Contact\u00a0search (field-based) Identification is required,","breadcrumb":{"@id":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/helpdev.minicrm.io\/help\/contact-actions\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/helpdev.minicrm.io\/help\/contact-actions\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.minicrm.hu\/help\/"},{"@type":"ListItem","position":2,"name":"Contact actions"}]},{"@type":"WebSite","@id":"https:\/\/www.minicrm.hu\/help\/#website","url":"https:\/\/www.minicrm.hu\/help\/","name":"Documenta\u021bie MiniCRM","description":"Welcome to MiniCRM","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.minicrm.hu\/help\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.minicrm.hu\/help\/#\/schema\/person\/8fabeab95ca44349ab8963bd5a41e3d7","name":"L\u00edvia F\u00fcl\u00f6p","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/f3134b1be47aa2326a775dd7090fd53fb8a694a561ad9cc5ec8f1e66ff8bacc4?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/f3134b1be47aa2326a775dd7090fd53fb8a694a561ad9cc5ec8f1e66ff8bacc4?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/f3134b1be47aa2326a775dd7090fd53fb8a694a561ad9cc5ec8f1e66ff8bacc4?s=96&d=mm&r=g","caption":"L\u00edvia F\u00fcl\u00f6p"}}]}},"_links":{"self":[{"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/posts\/5142","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/comments?post=5142"}],"version-history":[{"count":4,"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/posts\/5142\/revisions"}],"predecessor-version":[{"id":6384,"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/posts\/5142\/revisions\/6384"}],"wp:attachment":[{"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/media?parent=5142"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/categories?post=5142"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.minicrm.hu\/help\/wp-json\/wp\/v2\/tags?post=5142"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}