Update an entity

PUT /api/v1/entities/{entity_id}

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.

Path parameters

entity string Required

The ID of the desired entity (e.g., en_Ah3tqYn).

application/json

Body

address object

The contracting entity's address.
Hide address attributes Show address attributes object
- country string | null
  
  2-letter country code.
- line1 string
  
  Address line 1 (Street address/PO Box).
- line2 string | null
  
  Address line 2 (Apartment/Suite/Unit/Building).
- locality string
  
  City/District/Suburb/Town/Village.
- postalcode string
  
  ZIP or postal code.
- region string
  
  2-letter state code.
coverage_limit object

The contracting entity's minimum required coverage limits.
Hide coverage_limit attributes Show coverage_limit attributes object
- aggregate_limit integer Required
  
  The total amount the insurance company will pay for multiple claims over the course of one policy term.
  
  A positive integer representing the aggregate limit expressed in cents (e.g., 100000000 cents to represent $1,000,000). The minimum amount is 1000 cents US.
- occurrence_limit integer Required
  
  The total amount the insurance company will pay per incident during the policy term.
  
  A positive integer representing the per occurrence limit expressed in cents (e.g., 100000000 cents to represent $1,000,000). The minimum amount is 1000 cents US.
name string

The contracting entity's legal name.
required_coverage array

An array of coverage types that can include one or more of the following insurance coverage values: general, professional and workers-comp.

Values are workers_comp, general_liability, or professional_liability.

Responses

200 application/json

Returns the entity object if the update succeeded. Returns an error if update parameters are invalid.
Hide response attributes Show response attributes object
- address object
  
  Hide address attributes Show address attributes object
  
  country string | null
  
  2-letter country code.
  
  line1 string
  
  Address line 1 (Street address/PO Box).
  
  line2 string | null
  
  Address line 2 (Apartment/Suite/Unit/Building).
  
  locality string
  
  City/District/Suburb/Town/Village.
  
  postalcode string
  
  ZIP or postal code.
  
  region string
  
  2-letter state code.
- coverage_limit object
  
  The contracting entity's minimum required coverage limits.
  
  Hide coverage_limit attributes Show coverage_limit attributes object
  
  aggregate_limit integer Required
  
  The total amount the insurance company will pay for multiple claims over the course of one policy term.
  
  A positive integer representing the aggregate limit expressed in cents (e.g., 100000000 cents to represent $1,000,000). The minimum amount is 1000 cents US.
  
  occurrence_limit integer Required
  
  The total amount the insurance company will pay per incident during the policy term.
  
  A positive integer representing the per occurrence limit expressed in cents (e.g., 100000000 cents to represent $1,000,000). The minimum amount is 1000 cents US.
- created integer(int64)
  
  Time at which the object was created. Measured in seconds since the Unix epoch.
- 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, professional and workers-comp.
  
  Values are general, professional, or workers-comp.

PUT /api/v1/entities/{entity_id}

curl \
 --request PUT 'https://api.1099policy.com/api/v1/entities/{entity_id}' \
 --header "Content-Type: application/json" \
 --data '{"$ref":"#/components/examples/entity"}'

Request example

{
  "$ref": "#/components/examples/entity"
}

Response examples (200)

{
  "$ref": "#/components/examples/entity"
}