User Farm Write

PUT 
/:embedFarmId

User Farm Write

Request

Path Parameters

embedFarmId stringrequired

application/json

Body

farmName stringrequired

User provided name of the user farm (will be auto-generated if not provided)

clientId stringnullrequired

Client identifier associated with the user farm

metadata objectrequired

User defined metadata (consist of key-value pairs)

Responses

200

OK

application/json

Schema

Schema

dasFarmId uuidrequired

Unique identifier for the Rural Platform user farm

embedFarmId stringrequired

Unique identifier for the Embed user farm within the company

farmName stringrequired

User provided name of the user farm (will be auto-generated if not provided)

clientId stringnullrequired

Client identifier associated with the user farm

metadata objectrequired

User defined metadata (consist of key-value pairs)

Example (from schema)

{
  "dasFarmId": "2a382879-1dae-45f5-9a99-92d082b77c82",
  "embedFarmId": "6fa2b6b2-8ea4-401b-8cc3-88ffc97d27a1",
  "farmName": "Remote Wheat Farm",
  "clientId": "RW-1000",
  "metadata": {
    "owner": "Marcus Volkanovski",
    "insuredPartition": 5,
    "insured": true,
    "insurancePeriod": null
  }
}

Loading...