{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/persons.json","auth":"required","results":{"codes":[{"status":201,"language":"json","code":"{\n \"id\":733,\n \"company_id\":null,\n \"salutation\":\"Mr.\",\n \"title\":\"Dr\",\n \"first_name\":\"John\",\n \"last_name\":\"Doe\",\n \"birthday\":\"2000-01-01\",\n \"position\":\"CTO\",\n \"info\":\"A really nice guy!\",\n \"wants_mailing\":true,\n \"wants_newsletter\":false,\n \"wants_no_email\":false,\n \"wants_no_post\":false,\n \"wants_no_call\":false,\n \"greeting\":\"\",\n \"external_person_id\":\"ae34\",\n \"created_at\":\"2019-04-24 13:44:57\",\n \"updated_at\":\"2019-04-24 13:44:57\",\n \"fb_custom_fields\":[],\n \"fb_person_addresss\":[],\n \t\"fb_person_phones\":[],\n \"fb_person_email_addresss\":[],\n \"fb_person_websites\":[],\n \"fb_person_instant_messengers\":[],\n \"fb_person_bank_accounts\":[],\n \"fb_person_credit_cards\": [],\n \"fb_manual_tags\":[]\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n \"company_id\":null,\n \"salutation\":\"Mr.\",\n \"title\":\"Dr\",\n \"first_name\":\"John\",\n \"last_name\":\"Doe\",\n \"birthday\":\"2000-01-01\",\n \"position\":\"CTO\",\n \"info\":\"A really nice guy!\",\n \"wants_mailing\":true,\n \"wants_newsletter\":false,\n \"wants_no_email\":false,\n \"wants_no_post\":false,\n \"wants_no_call\":false,\n \"greeting\":\"\",\n \"external_person_id\":\"ae34\",\n \t\"fb_custom_fields\":[\n {\n \"id\":9,\n \"value\":\"red\"\n }\n ]\n}"}]},"method":"post","params":[]},"next":{"description":"","pages":[]},"title":"/persons.json","type":"endpoint","slug":"persons-create","excerpt":"Creates a new person.","body":"To create, update or delete child objects like fb_person_phone or fb_person_bank_accounts please take a look at the special endpoints like /personPhone, /personBankAccount etc.\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Description\",\n \"h-2\": \"Type\",\n \"h-3\": \"Mandatory\",\n \"0-0\": \"company_id\",\n \"1-0\": \"company_name\",\n \"2-0\": \"salutation\",\n \"3-0\": \"title\",\n \"4-0\": \"first_name\",\n \"5-0\": \"last_name\",\n \"6-0\": \"birthday\",\n \"7-0\": \"position\",\n \"8-0\": \"info\",\n \"9-0\": \"wants_mailing\",\n \"10-0\": \"wants_newsletter\",\n \"11-0\": \"wants_no_email\",\n \"12-0\": \"wants_no_post\",\n \"13-0\": \"wants_no_call\",\n \"14-0\": \"greeting\",\n \"15-0\": \"is_company\",\n \"16-0\": \"external_person_id\",\n \"0-2\": \"integer\",\n \"15-2\": \"boolean\",\n \"13-2\": \"boolean\",\n \"12-2\": \"boolean\",\n \"11-2\": \"boolean\",\n \"10-2\": \"boolean\",\n \"9-2\": \"boolean\",\n \"1-2\": \"string (1000)\",\n \"3-2\": \"string (50)\",\n \"4-2\": \"string (100)\",\n \"5-2\": \"string (100)\",\n \"7-2\": \"string (200)\",\n \"8-2\": \"string (1000)\",\n \"14-2\": \"string (1000)\",\n \"16-2\": \"string (100)\",\n \"6-2\": \"date\",\n \"2-2\": \"Enum (\\\"Mr.\\\", \\\"Mrs.\\\", \\\"diverse\\\", \\\"couple\\\", \\\"family\\\")\",\n \"5-3\": \"yes\",\n \"6-1\": \"The birthday (only if is_company=false)\",\n \"4-1\": \"The first name (only if is_company=false)\",\n \"5-1\": \"The last name (only if is_company=false)\",\n \"3-1\": \"The title (only if is_company=false)\",\n \"2-1\": \"The salutation (only if is_company=false)\",\n \"7-1\": \"The position (only if is_company=false)\",\n \"8-1\": \"Some information about the person\",\n \"14-1\": \"A individual greeting\",\n \"15-1\": \"true of it is a company\",\n \"16-1\": \"A kind of identifier that is used in any 3rd party systems\",\n \"1-1\": \"The name of the company if is_company=true\",\n \"9-1\": \"Information about contact opportunities\",\n \"10-1\": \"Information about contact opportunities\",\n \"11-1\": \"Information about contact opportunities\",\n \"12-1\": \"Information about contact opportunities\",\n \"13-1\": \"Information about contact opportunities\",\n \"0-1\": \"The optional id of a company (= another person) if this contact belongs to a company\"\n },\n \"cols\": 4,\n \"rows\": 17\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Custom fields\",\n \"body\": \"Please find further information about custom fields [at the custom fields section](doc:custom-fields).\"\n}\n[/block]","updates":[],"order":23,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cc04d1a61e8e40012eede6b","project":"571f5e8cd8667f0e00a3c498","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413","5e60d6278f8b380072f0b1e3"],"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"releaseDate":"2016-04-26T12:26:52.312Z","__v":14,"hasReference":true,"createdAt":"2016-04-26T12:26:52.312Z","project":"571f5e8cd8667f0e00a3c498"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON-REST-API (API-Package)","slug":"rest-api-json","order":9,"from_sync":false,"reference":false,"_id":"5cbeda4b862d090013abd413","project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","createdAt":"2019-04-23T09:26:35.210Z","__v":1},"user":"5720ba18c669e80e00c35051","createdAt":"2019-04-24T11:48:42.945Z","__v":2,"parentDoc":null}
post/persons.json
Creates a new person.
Definition
{{ api_url }}{{ page_api_url }}