{"_id":"558a6e9275eaf50d004e4bfa","editedParams2":true,"user":"54870d54f907080b00fc49cd","version":{"_id":"54870ea57810260b001c36ae","project":"54870ea47810260b001c36ab","__v":20,"createdAt":"2014-12-09T15:00:53.237Z","releaseDate":"2014-12-09T15:00:53.237Z","categories":["54870ea57810260b001c36af","5487116f7810260b001c36b5","548711797810260b001c36b6","548711807810260b001c36b7","548713127810260b001c36bd","548713247810260b001c36be","548713aa7810260b001c36c0","548713c2f907080b00fc49d5","548713eef907080b00fc49d9","54871a0db3441a1f00f20d78","54871b15b3441a1f00f20d7e","54871cbeb3441a1f00f20d87","548817fac178b40b00aa2eec","558a6dd975eaf50d004e4bf5","558a6e37dbe5b63700f8d1fe","56795d8c07bf6a0d0083ee9e","583e9d764ced340f00b05a5c","5d1f3f70b4648901728803b7","5d22f7db4c9e14005111e34f","5d22fa62a541770012a07464"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":16,"githubsync":"","parentDoc":null,"project":"54870ea47810260b001c36ab","editedParams":true,"category":{"_id":"558a6dd975eaf50d004e4bf5","version":"54870ea57810260b001c36ae","pages":["558a6e098d30cb2300873e1a","558a6e88dbe5b63700f8d201","558a6e9275eaf50d004e4bfa","558a6e9a8d30cb2300873e1c","558a79f2dbe5b63700f8d23f","5592abfb6bf22f170075b823","55a65e4580c8a30d00b32618","55ba22f804775a2f006280aa","55ba2648b3612925009d66f0","56045138e416560d00fa6484","560452e4e5102a0d0070f965","560455090c78b00d0039b18b","56176873a410c90d00c612aa","56176a014d9e4a17002a0e05","5628d38e0653060d00a2f7d9","5628d5d748742a0d0047456d","56a669cffb12a40d006c4826"],"__v":17,"project":"54870ea47810260b001c36ab","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-24T08:44:09.019Z","from_sync":false,"order":5,"slug":"api","title":"API"},"updatedAt":"2019-07-08T08:09:00.208Z","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-24T08:47:14.194Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"name":"","code":"{\n    \"site_id\": 999999,\n    \"unique_id\": \"uniid\"\n}","language":"json","status":201},{"code":"{\n    \"errors\": {\n        \"account_setting\": [\n            \"is not included in the list\"\n        ]\n    }\n}","language":"json","status":422,"name":""}]},"settings":"","examples":{"codes":[]},"auth":"required","params":[{"_id":"558a96ee75eaf50d004e4c9e","ref":"","in":"body","required":true,"desc":"Your authentication token.","default":"","type":"string","name":"auth_token"},{"_id":"558a96ee75eaf50d004e4c9d","ref":"","in":"body","required":true,"desc":"Your Project name","default":"","type":"string","name":"site.name"},{"_id":"558bb2e2cf331f23002046f8","ref":"","in":"body","required":true,"desc":"Your project unique ID. Has to be unique.","default":"","type":"string","name":"site.unique_id"},{"_id":"558bb2e2cf331f23002046f7","ref":"","in":"body","required":false,"desc":"Your layout name. Will be defaulted to the first available layout if this parameter is missing.","default":"","type":"string","name":"site.layout_name"},{"_id":"5593efa00e82e81700334e53","ref":"","in":"body","required":false,"desc":"Your project description.","default":"","type":"string","name":"site.description"},{"_id":"5593efa00e82e81700334e51","ref":"","in":"body","required":false,"desc":"Address line 1.","default":"","type":"string","name":"site.street"},{"_id":"5592a7886bf22f170075b80f","ref":"","in":"body","required":false,"desc":"Address line 2.","default":"","type":"string","name":"site.city_state_zipcode"},{"_id":"558bb30446a4d61900fbc2e5","ref":"","in":"body","required":false,"desc":"The international country code. Example \"BE\" for Belgium, \"GB\" for United Kingdom, \"US\" for the United States.","default":"","type":"string","name":"site.country"},{"_id":"558bb3ce49dc4f0d00517e8f","ref":"","in":"body","required":false,"desc":"Custom field.","default":"","type":"string","name":"site.additional_info"},{"_id":"5592a7886bf22f170075b813","ref":"","in":"body","required":false,"desc":"Custom field.","default":"","type":"string","name":"site.additional_info_2"},{"_id":"5592a7886bf22f170075b812","ref":"","in":"body","required":false,"desc":"Custom field.","default":"","type":"string","name":"site.additional_info_3"},{"_id":"5592a7886bf22f170075b811","ref":"","in":"body","required":false,"desc":"Custom field.","default":"","type":"string","name":"site.additional_info_4"},{"_id":"5592a7886bf22f170075b810","ref":"","in":"body","required":false,"desc":"Custom field.","default":"","type":"string","name":"site.additional_info_5"},{"_id":"5593efa00e82e81700334e52","ref":"","in":"body","required":false,"desc":"Report numbering will start at this number.","default":"","type":"string","name":"site.first_visit_number"},{"_id":"59c389eb2262d50032e94c99","ref":"","in":"body","required":false,"desc":"Add your own id for the project, you can then use this 'client_internal_unique_id' instead of the ArchiSnapper id in order to update projects, add contacts, reports etc...","default":"","type":"string","name":"site.client_internal_unique_id"},{"_id":"59ce338d3013dc001c34fc5b","ref":"","in":"body","required":false,"desc":"This allows to skip default user access for this project. By default, all existing users will get access to a project. Setting this to \"true\" will only give the admin user access.","default":"","type":"boolean","name":"site.skip_default_users"}],"url":"/sites"},"isReference":true,"order":4,"body":"","excerpt":"","slug":"creating-a-project","type":"endpoint","title":"Creating a project"}

postCreating a project


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

auth_token:
required
string
Your authentication token.
site.name:
required
string
Your Project name
site.unique_id:
required
string
Your project unique ID. Has to be unique.
site.layout_name:
string
Your layout name. Will be defaulted to the first available layout if this parameter is missing.
site.description:
string
Your project description.
site.street:
string
Address line 1.
site.city_state_zipcode:
string
Address line 2.
site.country:
string
The international country code. Example "BE" for Belgium, "GB" for United Kingdom, "US" for the United States.
site.additional_info:
string
Custom field.
site.additional_info_2:
string
Custom field.
site.additional_info_3:
string
Custom field.
site.additional_info_4:
string
Custom field.
site.additional_info_5:
string
Custom field.
site.first_visit_number:
string
Report numbering will start at this number.
site.client_internal_unique_id:
string
Add your own id for the project, you can then use this 'client_internal_unique_id' instead of the ArchiSnapper id in order to update projects, add contacts, reports etc...
site.skip_default_users:
boolean
This allows to skip default user access for this project. By default, all existing users will get access to a project. Setting this to "true" will only give the admin user access.

Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}