{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/customers","auth":"required","results":{"codes":[{"name":"","code":"{\n \"data\": { \n \"id\": 45,\n \"email\": \"jdoe:::at:::acme.corp\",\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}","language":"json","status":201},{"name":"","code":"{\n \"errors\": [\n {\n \"title\": \"Invalid field \\\"email\\\".\",\n \"detail\": \"Mandatory parameter \\\"email\\\" is empty or incorrect.\"\n }\n ]\n}","language":"json","status":400},{"status":401,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"Unauthorized\"\n }\n ]\n}"},{"code":"{\n \"errors\": [\n {\n \"title\": \"Invalid field \\\"email\\\".\",\n \"detail\": \"This email already exists.\"\n }\n ]\n}","language":"json","status":409}]},"settings":"","examples":{"codes":[{"name":"","code":"curl -H \"Authorization:Token b98f08d1c44cd5259dd70dc295e61187af45bffd23036f909919e608bdd8a592\" -X POST -d '{\"data\": {\"email\":\"[email protected]\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"note\":\"Our valuable customer\"}}' \"https://public-api.devmate.com/v2/customers/\"","language":"curl"}]},"method":"post","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":"56094876c5cff70d007d016a","project":"547cd7662eaee50800ed1089","user":"547cd6ac78fd57080023ca99","__v":7,"createdAt":"2015-09-28T14:02:30.969Z","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"categories":["547cd7672eaee50800ed108d","54c8f8ae0174630d00efa874","54c8f8bd7a11f60d0022a832","54c8f8c60174630d00efa876","54c8f8f10174630d00efa877","55155826bc466623002afe83","551558324c7c1e39003735a0","56052058e266000d008971c7","57909a453b845d0e006a37d5"],"_id":"547cd7662eaee50800ed108c","createdAt":"2014-12-01T21:02:30.851Z","project":"547cd7662eaee50800ed1089","releaseDate":"2014-12-01T21:02:30.851Z","__v":9},"githubsync":"","parentDoc":null,"editedParams":true,"category":{"sync":{"isSync":false,"url":""},"pages":["5605215df6b86e0d00284ab5","56052995d5c3900d0003e83d","56056243e266000d0089720e","56056496f6b86e0d00284b09","56094876c5cff70d007d016a","5609493a31beb60d001b65d9","56094af131beb60d001b65db"],"title":"Public API","slug":"public-api","order":8,"from_sync":false,"reference":false,"_id":"56052058e266000d008971c7","project":"547cd7662eaee50800ed1089","__v":7,"createdAt":"2015-09-25T10:22:16.805Z","version":"547cd7662eaee50800ed108c"},"editedParams2":true}
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