{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/rest/account","auth":"required","examples":{"codes":[{"code":"curl -X POST \"[host]/rest/account\" -b cookies.txt -d '{\"account_name\":\"new account\", \"active\":true}'","language":"curl"}]},"method":"post","params":[{"name":"customer_id","type":"string","default":"","desc":"An ID to identify the Account in an external customer system. For Beeswax use only!","required":false,"in":"body","ref":"","_id":"56c38f9c2d97560d00e23cba"},{"name":"alternative_id","type":"string","default":"","desc":"An alternative id to lookup the account, if desired","required":false,"in":"body","ref":"","_id":"56c38f9c2d97560d00e23cb9"},{"name":"account_name","type":"string","default":"","desc":"Name of the account","required":true,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b7"},{"name":"primary_account","type":"boolean","default":"","desc":"Not currently used","required":false,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b6"},{"name":"locale","type":"string","default":"en_US","desc":"Locale to use for the account, currently only en_US is supported","required":false,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b5"},{"name":"timezone","type":"string","default":"America/New_York","desc":"Timezone to use for the Account. Currently only EST is supported.","required":false,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b4"},{"name":"currency_id","type":"string","default":"USD","desc":"Currency to use for the Account. Currently the API assumes all currencies are dollars.","required":false,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b3"},{"name":"date_format_string","type":"string","default":"Y-m-d H:i:s","desc":"Format of dates for both inputs and outputs to the API.","required":false,"in":"body","ref":"","_id":"57ed3a7fc4f64e17004e5320"},{"name":"notes","type":"string","default":"","desc":"Notes about the Account, up to 255 chars","required":false,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b2"},{"name":"active","type":"boolean","default":"true","desc":"Is the Account active?","required":true,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b1"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"success\": true,\n    \"message\": \"account created with ID = 3\",\n    \"payload\": {\n        \"id\": 3\n    }\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"account","type":"endpoint","slug":"restaccount","excerpt":"","body":"","updates":[],"order":10,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c39b11e1e4190d003429b0","editedParams":true,"parentDoc":null,"project":"56c35c56c0c4630d004e864c","user":"56c35c45c4796b0d007eefdf","__v":2,"createdAt":"2016-02-16T21:56:33.050Z","githubsync":"","version":{"version":"0.5","version_clean":"0.5.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"_id":"56c35c56c0c4630d004e864f","createdAt":"2016-02-16T17:28:54.864Z","project":"56c35c56c0c4630d004e864c","releaseDate":"2016-02-16T17:28:54.864Z","__v":8},"editedParams2":true,"category":{"sync":{"isSync":false,"url":""},"pages":["56cf5bb88629f91300fd97c5","56cf5bf68629f91300fd97c7","56cf5fd2287eb20b009f9f37","56cf631a44c5700b0095c1c8","56cf63ae6c5d7a13005eeb58","56cf6408287eb20b009f9f40","56cf643a287eb20b009f9f43","56cf65ba336aa60b0086a435","56cf66df336aa60b0086a440","56cf69b344c5700b0095c1cf","56cf6a3d44c5700b0095c1d3","56cf6ac6336aa60b0086a44e","56cf6b298acacb13008148c9","56cf6cd68629f91300fd97e3","56cf6e048acacb13008148cd","56cf6eac336aa60b0086a455","56cf6edf287eb20b009f9f5a","56cf6f6b336aa60b0086a462","56cf704e8629f91300fd97f0","56cf70bf6c5d7a13005eeb6f","56cf72c6287eb20b009f9f76","56cf74c86c5d7a13005eeb7f","56cf75f5336aa60b0086a496","56cf76b68629f91300fd9801","56cf76da8629f91300fd9805","56cf776c8acacb13008148dc","56cf77ca6c5d7a13005eeb92","56cf788044c5700b0095c1fe","56cf78c28acacb13008148e5","56cf7a9544c5700b0095c207","56cf7b9b44c5700b0095c20c","56cf7c268629f91300fd980f","56cf7c456c5d7a13005eeba4","56d097b1376b040b005b3029","56d0992940d36e1d00bc13dd","56d099ed167e1e1b008079d2","56d09afa376b040b005b3032","56d09ba01ecc471500f1794a","56d09c13376b040b005b3034","56d09cde167e1e1b008079d7","56d09f30167e1e1b008079e2","56d0a00b376b040b005b303d","56d0a063167e1e1b008079e6","56d0a11a7c2e100b000af929","56d0b072167e1e1b00807a2e","56d0b0fb7c2e100b000af98b","56d0b16d1ecc471500f179af","56d0b1ee7c2e100b000af991","56d0b2407c2e100b000af998","56d0b2e640d36e1d00bc1456","56d0b3511ecc471500f179bc","56d0b3aab2cb7013004de65b","56d0b3d1b2cb7013004de65e","56d0b3fe7c2e100b000af9a1","56d0b4d67c2e100b000af9a5","56d0b52fb2cb7013004de666","56d0b59db2cb7013004de66c","56d0b621167e1e1b00807a4c","56d0b787167e1e1b00807a54","56d0b82d167e1e1b00807a55","56d0b8a8167e1e1b00807a5d","56d0b8fe167e1e1b00807a60","56d0b9951ecc471500f179c7","56d0ba55376b040b005b30a1","56d0bac31ecc471500f179cc","56d0bb6e167e1e1b00807a64","56d0bc95167e1e1b00807a6a"],"title":"Buzz API Reference","slug":"buzz-api-reference","order":1,"from_sync":false,"reference":true,"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","createdAt":"2016-02-25T17:53:10.154Z"}}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

customer_id:
string
An ID to identify the Account in an external customer system. For Beeswax use only!
alternative_id:
string
An alternative id to lookup the account, if desired
account_name:
required
string
Name of the account
primary_account:
boolean
Not currently used
locale:
stringen_US
Locale to use for the account, currently only en_US is supported
timezone:
stringAmerica/New_York
Timezone to use for the Account. Currently only EST is supported.
currency_id:
stringUSD
Currency to use for the Account. Currently the API assumes all currencies are dollars.
date_format_string:
stringY-m-d H:i:s
Format of dates for both inputs and outputs to the API.
notes:
string
Notes about the Account, up to 255 chars
active:
required
booleantrue
Is the Account active?

Examples


Result Format