Update a contractor

PUT /api/v1/contractors/{contractor}

Updates the specified contractor 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 contractor creation call.

Servers

• Production server: https://api.1099policy.com (Production server)

Parameters

Path parameters

• contractor (string)
  The ID of the desired contractor (e.g., cn_Ehb3bYa).

Body: application/json (object)

• address (object)
  The contractor's home address.

• company_name (string)
  The contractor's business name.

• custom_metadata (object)
  Set of key-value pairs that you can attach to an object. Used to store additional information about the contractor in a structured format. Individual keys can be unset by posting an empty value to them. Pass an empty value, e.g. {}, to custom_metadata to unset all keys.

• email (string)
  The contractor's email address.

• first_name (string)
  The contractor's first name.

• last_name (string)
  The contractor's last name.

• middle_name (string)
  The contractor's middle name.

• phone (string)
  The contractor's phone number.

• withhold_premium (boolean)
  This indicates whether the contractor is paying premium directly with their credit card (i.e., false) or if the contractor has given the platform that's integrating with 1099Policy permission to withhold the premium payment from their wages and pay the premium on the contractor's behalf (i.e., true). Defaults to false.

Responses

200

Returns the contractor object if the update succeeded. Returns an error if update parameters are invalid.

Body: application/json (object)

• address (object)

• company_name (string | null)
  The contractor's business name.

• created (integer(int64))

• custom_metadata (object)
  Set of key-value pairs that you can attach to the contractor object. Used for storing additional information in a structured format. Individual keys can be unset by posting an empty value to them. Pass an empty value, e.g. {}, to custom_metadata to unset all keys.

• email (string)
  The contractor's email address.

• first_name (string)
  The contractor's first name.

• id (string)

• last_name (string)
  The contractor's last name.

• middle_name (string | null)
  The contractor's middle name.

• phone (string)
  The contractor's phone number.

• withhold_premium ()
  This indicates whether the contractor is paying premium directly with their credit card (i.e., false) or if the contractor has given the platform that's integrating with 1099Policy permission to withhold the premium payment from their wages and pay the premium on the contractor's behalf (i.e., true). Defaults to false.