{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/customers","auth":"required","examples":{"codes":[{"name":"","language":"curl","code":"curl -H \"Authorization:Token b98f08d1c44cd5259dd70dc295e61187af45bffd23036f909919e608bdd8a592\" -X POST -d '{\"data\": {\"email\":\"jdoe:::at:::acme.corp\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"note\":\"Our valuable customer\"}}' \"https://public-api.devmate.com/v2/customers/\""}]},"method":"post","results":{"codes":[{"language":"json","code":"{\n \"data\": { \n \"id\": 45,\n \"email\": \"[email protected]\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"MacPaw\",\n \"phone\": \"5553423322\",\n \"address\": \"Madison Ave. 11\",\n \"note\": \"Our valuable customer\",\n \"date_added\": 1443185520\n }\n}","name":"","status":201},{"status":400,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"Invalid field \\\"email\\\".\",\n \"detail\": \"Mandatory parameter \\\"email\\\" is empty or incorrect.\"\n }\n ]\n}","name":""},{"status":401,"code":"{\n \"errors\": [\n {\n \"title\": \"Unauthorized\"\n }\n ]\n}","language":"json"},{"status":409,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"Invalid field \\\"email\\\".\",\n \"detail\": \"This email already exists.\"\n }\n ]\n}"}]},"settings":"","params":[{"name":"data[email]","type":"string","default":"","desc":"Customer's email (**mandatory**)","required":true,"in":"body","ref":"","_id":"56094a40a7b2590d0089eb89"},{"name":"data[last_name]","type":"string","default":"","desc":"Customer's last name","required":false,"in":"body","ref":"","_id":"56094a40a7b2590d0089eb8b"},{"name":"data[first_name]","type":"string","default":"","desc":"Customer's first name","required":false,"in":"body","ref":"","_id":"56094a40a7b2590d0089eb8a"},{"name":"data[company]","type":"string","default":"","desc":"Customer's company name","required":false,"in":"body","ref":"","_id":"57c04ae964ebf60e006886ed"},{"name":"data[phone]","type":"string","default":"","desc":"Customer's phone number","required":false,"in":"body","ref":"","_id":"57c04ae964ebf60e006886ec"},{"name":"data[address]","type":"string","default":"","desc":"Customer's address","required":false,"in":"body","ref":"","_id":"57c04ae964ebf60e006886eb"},{"name":"data[note]","type":"string","default":"","desc":"Additional notes","required":false,"in":"body","ref":"","_id":"563a204dd25e8919005f3ec8"}]},"next":{"description":"","pages":[]},"title":"Create Customer","type":"endpoint","slug":"create-customer","excerpt":"","body":"This method is used to add information about customer.\n\n`email` is a mandatory field and should be unique.\n\nExample request demonstrates adding a customer John Doe with an email [email protected]\n\n#Response Codes\n[block:parameters]\n{\n \"data\": {\n \"0-0\": \"`201`\",\n \"0-1\": \"Customer was created successfully\",\n \"1-0\": \"`400`\",\n \"1-1\": \"Request parameter is absent or incorrect. For example, wrong email address.\",\n \"3-0\": \"`409`\",\n \"3-1\": \"Customer with such email is already registered\",\n \"4-0\": \"`500`\",\n \"4-1\": \"Server error\",\n \"2-0\": \"`401`\",\n \"2-1\": \"Authorization failed\"\n },\n \"cols\": 2,\n \"rows\": 5\n}\n[/block]","updates":["563bbf3fe951f60d000b45a2","5912de0fc188f10f00502ded"],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"591f17b521d2ff0f00cf5a76","parentDoc":null,"githubsync":"","version":{"version":"1.0.1","version_clean":"1.0.1","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["591f17af21d2ff0f00cf5a40","591f17af21d2ff0f00cf5a41","591f17af21d2ff0f00cf5a42","591f17af21d2ff0f00cf5a43","591f17af21d2ff0f00cf5a44","591f17af21d2ff0f00cf5a45","591f17af21d2ff0f00cf5a46","591f17af21d2ff0f00cf5a47","591f17af21d2ff0f00cf5a48"],"_id":"591f17ae21d2ff0f00cf5a3f","createdAt":"2017-05-19T16:05:02.775Z","__v":1,"project":"547cd7662eaee50800ed1089","releaseDate":"2017-05-19T16:05:02.775Z"},"__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Public API","slug":"public-api","order":8,"from_sync":false,"reference":false,"_id":"591f17af21d2ff0f00cf5a48","__v":0,"project":"547cd7662eaee50800ed1089","createdAt":"2015-09-25T10:22:16.805Z","version":"591f17ae21d2ff0f00cf5a3f"},"project":"547cd7662eaee50800ed1089","user":"547cd6ac78fd57080023ca99","createdAt":"2015-09-28T14:02:30.969Z"}
postCreate Customer
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Body Params
data[email]:
required
string
Customer's email (**mandatory**)
data[last_name]:
string
Customer's last name
data[first_name]:
string
Customer's first name
data[company]:
string
Customer's company name
data[phone]:
string
Customer's phone number
data[address]:
string
Customer's address
data[note]:
string
Additional notes