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

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 }}