Accounts
Account Deletion Behavior
User Roles
Role
Can View
Can Edit Geometries
Can Manage
Changing Account Roles
get
Responses
200Success
application/json
idstringRead-onlyRequired
account_emailstringRequired
embedded_urlstringRead-onlyRequired
account_accessstringRead-onlyRequired
get
/api/accounts/200Success
post
Body
idstringRead-onlyRequired
account_emailstringRequired
embedded_urlstringRead-onlyRequired
account_accessstringRead-onlyRequired
Responses
201Success
application/json
post
/api/accounts/201Success
put
Update account information. If the request contains embedded_conf, it must be a JSON object with boolean values.
Allowed keys for `embedded_conf` are:
- COMPARISON_TAB_VIEW
- GRAPHS_TAB_VIEW
- NOTES_TAB_VIEW
- ZONING_TAB_VIEW
- WEATHER_FORECAST_TAB_VIEW
- ADVANCED_TAB_VIEW
- TREE_ANALYSIS_TAB_VIEW
- CROPS_TAB_VIEW
- ACCOUNT_LIMITS (object) - Account-level limits
- MAX_PARCEL_SIZE (number) - Max parcel size in hectares. Cannot exceed the company limit.
Example payload:
{
"embedded_conf": {
"COMPARISON_TAB_VIEW": true,
"ACCOUNT_LIMITS": {
"MAX_PARCEL_SIZE": 50
}
}
}
Path parameters
idstringRequired
Body
idstringRead-onlyRequired
account_emailstringRequired
embedded_urlstringRead-onlyRequired
account_accessstringRead-onlyRequired
Responses
200Success
application/json
idstringRead-onlyRequired
account_emailstringRequired
embedded_urlstringRead-onlyRequired
account_accessstringRead-onlyRequired
put
/api/accounts/{id}/200Success
delete
Path parameters
idstringRequired
Responses
204
No response body
delete
/api/accounts/{id}/204
No response body
No content
Last updated