operation put api v1 entities parameter.md
Update an entity
PUT /api/v1/entities/{entity}
Updates the specified entity by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts mostly the same arguments as the entity creation call.
Servers
- Production server: https://api.1099policy.com (Production server)
Parameters
Path parameters
- entity (string)
The ID of the desired entity (e.g.,en_Ah3tqYn).
Body: application/json (object)
address (object)
The contracting entity's address.coverage_limit (object)
The contracting entity's minimum required coverage limits.name (string)
The contracting entity's legal name.required_coverage (array[string])
An array of coverage types that can include one or more of the following insurance coverage values:general,professional,workers-comp,media, andcyber.
Responses
200
Returns the entity object if the update succeeded. Returns an error if update parameters are invalid.
Body: application/json (object)
address (object)
coverage_limit (object)
The contracting entity's minimum required coverage limits.created (integer(int64))
id (string)
name (string)
The contracting entity's legal name.required_coverage (array[string])
An array of coverage types that can include one or more of the following insurance coverage values:general,professionalandworkers-comp.