--- title: "Update an employer" method: PUT path: "/employers/{employer_id}" tags: ["Employers"] --- # Update an employer `PUT /employers/{employer_id}` Updates the specified `employer` by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the `legal_address` parameter only the `legal_address` value will be changed. Note that the `legal_address` and `contact` fields are treated as single objects that are updated entirely. If you provide either of these fields, the entire object will be replaced with the new data, not just the individual sub-fields you include in the request.For instance, if you provide a partial `legal_address` object, it will overwrite the entire existing `legal_address`, potentially removing any sub-fields you didn't include in the request. This request accepts mostly the same arguments as the `employer` creation call. ## Path parameters - `employer_id` string, required ## Headers - `X-Platform-Id` string ## Request body - UpdateEmployerRequest - `legal_name` string, nullable - `registration_number` string, nullable - `legal_address` AddressModelWithoutCountry - `line1` string, required — Must not be empty. NOTE: This field will be normalized according to our internal formatting rules. - `line2` string, nullable — NOTE: This field will be normalized according to our internal formatting rules. - `line3` string, nullable — NOTE: This field will be normalized according to our internal formatting rules. - `city` string, required — Must not be empty. NOTE: This field will be normalized according to our internal formatting rules. - `state` string, nullable — Required for United States (State), and Canada (Province). NOTE: This field will be normalized according to our internal formatting rules. - `postal_code` string, required — Must not be empty, and a valid postal code for the specified country. NOTE: This field will be normalized according to our internal formatting rules. - `contact` ContactModel - `name` string, required — Contact person name. NOTE: This field will be normalized according to our internal formatting rules. - `email` string, required — Contact email address. NOTE: This field will be normalized according to our internal formatting rules. - `earliest_benefits_start_date` string, date, nullable — The earliest date this employer is permitted to set up any benefits scheme. If this date is in the future, benefit setup will be blocked until then. Used to delay scheme setup access (e.g., for onboarding alignment). **Constraints:** - Can only be set or updated if no group policy or group quote exists. - Must be a valid date. - `metadata` object, nullable — Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters. Treated as a single object that is updated entirely. ## Response `200` OK - EmployerResponse - `id` string, required - `platform_id` string - `status` 'pending' | 'active' | 'offboarding' | 'inactive' | 'restricted' - `legal_name` string, required - `registration_number` string, nullable - `legal_address` AddressModel, required - `line1` string, required — Must not be empty. NOTE: This field will be normalized according to our internal formatting rules. - `line2` string, nullable — NOTE: This field will be normalized according to our internal formatting rules. - `line3` string, nullable — NOTE: This field will be normalized according to our internal formatting rules. - `city` string, required — Must not be empty. NOTE: This field will be normalized according to our internal formatting rules. - `state` string, nullable — Required for United States (State), and Canada (Province). NOTE: This field will be normalized according to our internal formatting rules. - `postal_code` string, required — Must not be empty, and a valid postal code for the specified country. NOTE: This field will be normalized according to our internal formatting rules. - `country_code` 'af' | 'ax' | 'al' | 'dz' | 'as' | 'ad' | 'ao' | 'ai' | 'aq' | 'ag' | 'ar' | 'am' | 'aw' | 'au' | 'at' | 'az' | 'bs' | 'bh' | 'bd' | 'bb' | 'by' | 'be' | 'bz' | 'bj' | 'bm' | 'bt' | 'bo' | 'bq' | 'ba' | 'bw' | 'bv' | 'br' | 'io' | 'bn' | 'bg' | 'bf' | 'bi' | 'cv' | 'kh' | 'cm' | 'ca' | 'ky' | 'cf' | 'td' | 'cl' | 'cn' | 'cx' | 'cc' | 'co' | 'km' | 'cg' | 'cd' | 'ck' | 'cr' | 'ci' | 'hr' | 'cu' | 'cw' | 'cy' | 'cz' | 'dk' | 'dj' | 'dm' | 'do' | 'ec' | 'eg' | 'sv' | 'gq' | 'er' | 'ee' | 'sz' | 'et' | 'fk' | 'fo' | 'fj' | 'fi' | 'fr' | 'gf' | 'pf' | 'tf' | 'ga' | 'gm' | 'ge' | 'de' | 'gh' | 'gi' | 'gr' | 'gl' | 'gd' | 'gp' | 'gu' | 'gt' | 'gg' | 'gn' | 'gw' | 'gy' | 'ht' | 'hm' | 'va' | 'hn' | 'hk' | 'hu' | 'is' | 'in' | 'id' | 'ir' | 'iq' | 'ie' | 'im' | 'il' | 'it' | 'jm' | 'jp' | 'je' | 'jo' | 'kz' | 'ke' | 'ki' | 'kp' | 'kr' | 'xk' | 'kw' | 'kg' | 'la' | 'lv' | 'lb' | 'ls' | 'lr' | 'ly' | 'li' | 'lt' | 'lu' | 'mo' | 'mg' | 'mw' | 'my' | 'mv' | 'ml' | 'mt' | 'mh' | 'mq' | 'mr' | 'mu' | 'yt' | 'mx' | 'fm' | 'md' | 'mc' | 'mn' | 'me' | 'ms' | 'ma' | 'mz' | 'mm' | 'na' | 'nr' | 'np' | 'nl' | 'nc' | 'nz' | 'ni' | 'ne' | 'ng' | 'nu' | 'nf' | 'mk' | 'mp' | 'no' | 'om' | 'pk' | 'pw' | 'ps' | 'pa' | 'pg' | 'py' | 'pe' | 'ph' | 'pn' | 'pl' | 'pt' | 'pr' | 'qa' | 're' | 'ro' | 'ru' | 'rw' | 'bl' | 'sh' | 'kn' | 'lc' | 'mf' | 'pm' | 'vc' | 'ws' | 'sm' | 'st' | 'sa' | 'sn' | 'rs' | 'sc' | 'sl' | 'sg' | 'sx' | 'sk' | 'si' | 'sb' | 'so' | 'za' | 'gs' | 'ss' | 'es' | 'lk' | 'sd' | 'sr' | 'sj' | 'se' | 'ch' | 'sy' | 'tw' | 'tj' | 'tz' | 'th' | 'tl' | 'tg' | 'tk' | 'to' | 'tt' | 'tn' | 'tr' | 'tm' | 'tc' | 'tv' | 'ug' | 'ua' | 'ae' | 'gb' | 'um' | 'us' | 'uy' | 'uz' | 'vu' | 've' | 'vn' | 'vg' | 'vi' | 'wf' | 'eh' | 'ye' | 'zm' | 'zw', required - `contact` ContactModel, required - `name` string, required — Contact person name. NOTE: This field will be normalized according to our internal formatting rules. - `email` string, required — Contact email address. NOTE: This field will be normalized according to our internal formatting rules. - `offboard_on` string, date-time, nullable - `earliest_benefits_start_date` string, date, nullable - `metadata` object, nullable — Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters. - `object` string — The object type ## Other responses - `400` — Bad Request - `404` — Not Found --- [API](https://skmtc.net/kota/apis/kota-api.md) · [All operations](https://skmtc.net/kota/apis/kota-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kota/kota-api/revisions/7b8b3ed87c96/schema)