Accounts

get
Responses
200Success
application/json
get
GET /api/accounts/ HTTP/1.1
Host: 
Accept: */*
200Success
[
  {
    "id": "text",
    "account_email": "text",
    "embedded_url": "text",
    "account_access": "text"
  }
]
post
Body
idstringRead-onlyRequired
account_emailstringRequired
embedded_urlstringRead-onlyRequired
account_accessstringRead-onlyRequired
Responses
201Success
application/json
post
POST /api/accounts/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "account_email": "text"
}
201Success
{
  "id": "text",
  "account_email": "text",
  "embedded_url": "text",
  "account_access": "text"
}
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

        Example payload:
        {
            "embedded_conf": {
                "COMPARISON_TAB_VIEW": true,
                "GRAPHS_TAB_VIEW": false,
                "NOTES_TAB_VIEW": true
            }
        }
Path parameters
idstringRequired
Body
idstringRead-onlyRequired
account_emailstringRequired
embedded_urlstringRead-onlyRequired
account_accessstringRead-onlyRequired
Responses
200Success
application/json
put
PUT /api/accounts/{id}/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "account_email": "text"
}
200Success
{
  "id": "text",
  "account_email": "text",
  "embedded_url": "text",
  "account_access": "text"
}
delete
Path parameters
idstringRequired
Responses
204

No response body

No content
delete
DELETE /api/accounts/{id}/ HTTP/1.1
Host: 
Accept: */*
204

No response body

No content
PreviousAPI ReferenceNextFarms

Last updated