2026-01-12
Updated the GraphQL schema and the GraphQL API Reference with these changes:
Employer Data API
Documentation(48)
Documentation
- Changed the description of field
AttributeUpdateError.detail[removed: Details about the error][added: Error details].[removed: ] - Changed the description of field
AttributeUpdateError.detail[removed: In case of error, the error information will be][added: Errors appear] in the standard GraphQL errors array[added: .] - Changed the description of field
AttributeUpdateError.message[removed: A short][added: Short error] message[removed: that describes the error]. - Changed the description of field
AttributeUpdateError.message[removed: In case of error, the error information will be][added: Errors appear] in the standard GraphQL errors array[added: .] - Changed the description of field
AttributeUpdateError.suggestion[removed: Suggestion to help recover from the error][added: Recovery suggestion].[removed: ] - Changed the description of field
AttributeUpdateError.suggestion[removed: In case of error, the error information will be][added: Errors appear] in the standard GraphQL errors array[removed: ][added: .] - Changed the description of type
AttributeUpdateResponseCodeStandard GraphQL error code[removed: that][added: . See] MUST report standardized error codes for commonly encountered errors [229][removed: describes]. - Changed the description of
enumvalueAttributeUpdateResponseCode.BAD_USER_INPUT[removed: The value of an][added: Invalid] input parameter[removed: is invalid].[removed: This error code applies][added: Applies] to[removed: input ]validation[removed: performed ]beyond[removed: the ]standard GraphQL[removed: client and server libraries non-null and type][added: type/`null`] checking.[removed: ] - Changed the description of
enumvalueAttributeUpdateResponseCode.FORBIDDENValid[removed: authentication ]credentials[removed: are present ]but insufficient[removed: to perform the associated operation][added: permissions].[removed: This error code is the GraphQL equivalent of the][added: Equivalent to] HTTP `403 Forbidden`[removed: response status code]. - Changed the description of
enumvalueAttributeUpdateResponseCode.INTERNAL_SERVER_ERROR[removed: The][added: Unexpected] server[removed: encountered an unexpected ]failure[removed: and did not provide a response].[removed: Use this generic][added: Generic] error for[removed: failures that the server cannot handle][added: unhandled failures]. - Changed the description of
enumvalueAttributeUpdateResponseCode.PARTIAL_SUCCESS[removed: Partial-success if the response contains only part of successful response because of][added: Partial success due to] some failures.[removed: ] - Changed the description of
enumvalueAttributeUpdateResponseCode.QUERY_TOO_COMPLEX[removed: The query][added: Query] exceeded[removed: the allowed ]complexity[removed: for a single request][added: limit]. - Changed the description of
enumvalueAttributeUpdateResponseCode.UNAUTHENTICATED[removed: The operation was not attempted because the request did not include sufficient][added: Insufficient] authentication credentials[removed: for the operation].[removed: This error code is the GraphQL equivalent of the][added: Equivalent to] HTTP `401 Unauthorized`[removed: response status code].[removed: ] - Changed the description of type
CountrySpecificEmployerAttributesInput[removed: Country specific][added: Country-specific] data[added: .] - Changed the description of
inputfieldCountrySpecificEmployerAttributesInput.country[removed: An ]ISO 3166-1[removed: - alpha 2-encoded][added: alpha-2] country code[removed: string, ][added: (]such as[removed: ,]`US`[removed: or][added: ,] `JP`[added: )].[removed: ] - Changed the description of
inputfieldCountrySpecificEmployerAttributesInput.employees[removed: Size of the employers][added: Employers] workforce[added: size]. Allowed values[removed: are]: | Value | Number of employees | |:------------------|--------------------:| | `ERv1_1` | 1 | | `ERv1_2_10` | From 2 to 10 | | `ERv1_11_50` | From 11 to 50 | | `ERv1_1_50` | From 1 to 50 | | `ERv1_51_200` | From 51 to 200 | | `ERv1_201_500` | From 201 to 500 | | `ERv1_501_1000` | From 501 to 1000 | | `ERv1_1001_5000` | From 1001 to 5000 | | `ERv1_5001_10000` | From 5001 to 10000 | | `ERv1_10000_PLUS` | 10000+ employees |[removed: ] - Changed the description of
inputfieldCountrySpecificEmployerAttributesInput.isGlobalDefaultDeprecated.[removed: If the data the global default, set `isGlobalDefault=true`][added: Always `true` for `CountrySpecificEmployerAttributes`].[removed: If `isGlobalDefault=true` in addition to its normal locale][added: When `true`], data is also written to `ww_WW` internally.[removed: This field is deprecated because it is always `true` for `CountrySpecificEmployerAttributes`. ] - Changed the description of
inputfieldCountrySpecificEmployerAttributesInput.phoneNumDeprecated.[removed: Employers official phone number. ]Use[removed: the ]`phoneNumber`[removed: field ]instead.[removed: ] - Changed the description of
inputfieldCountrySpecificEmployerAttributesInput.phoneNumberEmployers official phone number[removed: . The value must follow the standard][added: in] [E.164](https://en.wikipedia.org/wiki/E.164) format.[removed: For example,][added: Example:] `+17895551234`[removed: . ] - Changed the description of
inputfieldCountrySpecificEmployerAttributesInput.sectorSUIDs[removed: List of Indeed sector][added: Sector] (industry)[removed: short unique identifiers (]SUIDs[removed: )].[removed: The maximum number of SUIDs is][added: Maximum] 3[removed: . Each value][added: ,] must be[removed: a ]valid[removed: SUID].[removed: See this table: **Market-specific documentation** | Market | Example value | |:-------|:--------------| | ]Japan[removed: | [Valid company sector SUID values]][added: : [Company sectors]](https://docs.indeed.com/employers/reference/company-sector).[removed: | ] - Changed the description of
inputfieldCountrySpecificEmployerAttributesInput.taxIdEmployers tax identifier. Limit[removed: is][added: :] 100 characters.[removed: **Market-specific documentation** | Market | Example value | |:-------|:--------------| | ]Japan[removed: |][added: :] If [`employerType`](/api/employer/objects/EmployerAttributesInput) is `JURIDICAL_PERSON`, set[removed: this field ]to the corporate number (法人番号)[removed: to correctly identify the company][added: for correct identification].[removed: <br/><br/>If ][added: If ]`employerType` is `NATURAL_PERSON`, this field is optional.[removed: | ] - Changed the description of
inputfieldCountrySpecificEmployerAttributesInput.websiteUrl[removed: The][added: Employers] root website[removed: of the `employer`—for example,][added: (such as] `indeed.com`[added: )].[removed: If the employer is a franchise][added: For franchises], use the brand website.[removed: Limit is][added: Limits:] 400 characters. Must be a valid URL.[removed: ] - Changed the description of type
EmployerAttributesInput[removed: Input object that contains][added: Updatable] employer attributes[removed: that you can update]. - Changed the description of
inputfieldEmployerAttributesInput.countrySpecificAttributes[removed: Employer attributes that can differ by country][added: Country-specific employer attributes].[removed: ] - Changed the description of
inputfieldEmployerAttributesInput.jpNewGradsAttributes[removed: Employer attributes that are specific to JP New-Grads][added: JP new grads employer attributes].[removed: ] - Changed the description of
inputfieldEmployerAttributesInput.localeSpecificAttributes[removed: Employer attributes that can differ by locale][added: Locale-specific employer attributes] (`lang` + `country`).[removed: ] - Changed the description of type
JpNewGradsEmployerAttributesInput[removed: Employer attributes that are specific to JP New-Grads][added: JP new grads employer attributes.] - Changed the description of
inputfieldJpNewGradsEmployerAttributesInput.schoolsWithHiringRecords[removed: A list of schools from which][added: Schools] the employer has[removed: previously ]hired graduates[added: from].[removed: Each school name must be fewer than][added: Limits: Max 1000 schools, each name under] 100 characters[removed: , and the total number of schools cannot exceed 1000].[removed: ] - Changed the description of type
LeaderInput[removed: Leaders][added: Leader] information. - Changed the description of
inputfieldLeaderInput.name[removed: Leaders][added: Leader] name[removed: ][added: .] - Changed the description of type
LocaleSpecificEmployerAttributesInput[removed: Attributes that are bound to specific locales][added: Locale-specific attributes.] - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.country[removed: An ]ISO 3166-1[removed: alpha 2-encoded][added: alpha-2] country code[removed: string—for example,][added: (such as] `US`[removed: or][added: ,] `JP`[added: )]. `ww_WW` is not accepted[removed: for worldwide default data]. All data must[removed: set][added: specify] a valid country and language.[removed: ] - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.description[removed: Description of the employer][added: Employer description].[removed: ] - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.headquarterAddress[removed: Headquarter][added: Headquarters] address.[removed: Referenced as][added: Japan:] 本社所在地住所[removed: in Japans market. ] - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.isGlobalDefaultIf `true`,[removed: defines the][added: sets this] data as the global default.[removed: ] - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.language[removed: An ]ISO 639-1[removed: - alpha 2-encoded][added: alpha-2] language code[removed: string—for example,][added: (such as] `en`[removed: or][added: ,] `ja`[added: )]. `ww_WW` is not accepted[removed: for worldwide default data]. All data must[removed: set][added: specify] a valid country and language.[removed: ] - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.leader[removed: Leaders][added: Leader] information.[removed: ] - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.localizedName[removed: Employer name in the locale. Length is from 1 to 60 characters. :::note If the request uses the `Ignore` operation to omit this field but provides `employerName`, then the global `localizedName` field is set to the [`employerName`](/api/employer/objects/PatchEmployerInput) field value. ::: **Examples** | Field | Example value | |:----------------|:-----------------------| | `name` | Yamada Kyujin | | `localizedName` | 山田求人 (ja_JP) | | `phoneticName` | ヤマダキュウジン (ja_JP) | | Field | Example value | |:----------------|:-----------------------| | `name` | Google | | `localizedName` | グーグル (ja_JP) | | `phoneticName` | グーグル (ja_JP) | | Field | Example value | |:----------------|:-----------------------| | `name` | Rakuten | | `localizedName` | 楽天 (ja_JP) | | `phoneticName` | ラクテン (ja_JP) | ][added: Localized employer name. Limit: 1 to 60 characters. :::note If the request uses the `Ignore` operation to omit this field but provides `employerName`, then the global `localizedName` field is set to the [`employerName`](/api/employer/objects/PatchEmployerInput) field value. ::: **Examples**: | Field | Example value | |:----------------|:-----------------------| | `name` | Yamada Kyujin | | `localizedName` | 山田求人 (ja_JP) | | `phoneticName` | ヤマダキュウジン (ja_JP) | | Field | Example value | |:----------------|:-----------------------| | `name` | Google | | `localizedName` | グーグル (ja_JP) | | `phoneticName` | グーグル (ja_JP) | | Field | Example value | |:----------------|:-----------------------| | `name` | Rakuten | | `localizedName` | 楽天 (ja_JP) | | `phoneticName` | ラクテン (ja_JP) |] - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.phoneticName[removed: Phonetic name of the employer][added: Employer phonetic name]. Limit[removed: is][added: :] 250 characters. **Examples**[added: :] | Field | Example value | |:----------------|:-----------------------| | `name` | Yamada Kyujin | | `localizedName` | 山田求人 (ja_JP) | | `phoneticName` | ヤマダキュウジン (ja_JP) | | Field | Example value | |:----------------|:-----------------------| | `name` | Google | | `localizedName` | グーグル (ja_JP) | | `phoneticName` | グーグル (ja_JP) | | Field | Example value | |:----------------|:-----------------------| | `name` | Rakuten | | `localizedName` | 楽天 (ja_JP) | | `phoneticName` | ラクテン (ja_JP) | - Changed the description of
inputfieldLocaleSpecificEmployerAttributesInput.squareLogoBase64-encoded square logo.[removed: Must be a square image with these dimensions][added: Dimensions]: *[removed: **Minimum**][added: Minimum]:[removed: 256x256][added: 256×256] pixels *[removed: **Maximum**][added: Maximum]:[removed: 4096x4096][added: 4096×4096] pixels - Changed the description of field
Mutation.patchEmployerCreates or updates an employer.[removed: * ]If[removed: Indeed resolves ]`input.id`[removed: to][added: matches] an [added: existing ]employer,[removed: it ]updates[removed: the specified fields for that employer. * If Indeed cannot resolve `input][added: it].[removed: id` to an employer][added: Otherwise],[removed: it ]creates an employer.[removed: If the request succeeds, the API returns][added: Returns] the `employerKey`[removed: for the updated or new employer. Depending ]on[removed: the client type, some Indeed][added: success. **Protected employers:** Some] employers are marked as[removed: *protected*][added: protected]. You can[removed: update ]only[added: update]:[removed: -][added: *] Non-protected[removed: Indeed ]employers[removed: -][added: *] Protected[removed: Indeed ]employers[removed: created by the same][added: your] client[removed: You cannot update][added: created Updating a] protected[removed: Indeed employers that other clients][added: employer] created[removed: . If you try to do so, the API][added: by another client] returns[removed: the][added: a] `FORBIDDEN` error.[removed: When you call the Indeed PLUS APIs][added: **Timeout:** Set a 5],[removed: initiate a][added: 000 ms] timeout[removed: after 5,000 milliseconds. ][added: for Indeed PLUS API calls.] - Changed the description of
inputfieldPatchEmployerInput.employerAttributesEmployer attributes to update. If null,[removed: no employer attributes are][added: nothing is] updated.[removed: ] - Changed the description of
inputfieldPatchEmployerInput.employerNameOfficial employer name[removed: , which is required][added: . Required] to create an[removed: Indeed ]employer key[removed: , and][added: ;] optional[removed: to submit][added: for submitting] employer data.[removed: Limit is][added: Limits:] 255[removed: UTF-16-encoded][added: UTF-16] characters.[removed: Cannot include the][added: No] email[removed: address][added: addresses] or[removed: eight][added: 8+] consecutive digits. :::note[removed: The value of ]`employerName` is copied to the[removed: **global**][added: global] [`localizedName`](/api/employer/objects/LocaleSpecificEmployerAttributesInput) field[removed: , except when the request][added: unless] explicitly[removed: sets the **global** [`localizedName`](/api/employer/objects/LocaleSpecificEmployerAttributesInput) field][added: set in the request]. ::: - Changed the description of
inputfieldPatchEmployerInput.id[removed: The globally][added: Globally] unique[removed: Internationalized Resource Identifier (]IRI[removed: )]for the employer.[removed: ] - Changed the description of field
PatchEmployerPayload.attributeUpdated[removed: If ]`true`[removed: , the][added: if] employer[removed: attribute was][added: attributes were] updated[removed: ,].[removed: Otherwise, `false`. ] - Changed the description of field
PatchEmployerPayload.errorsList of errors.[removed: If no errors occur, returns an empty array][added: Empty if none].[removed: ] - Changed the description of field
PatchEmployerPayload.errors[removed: In case of error, the error information will be][added: Errors appear] in the standard GraphQL errors array[removed: ][added: .] - Changed the description of field
PatchEmployerPayload.responseCode[removed: In case of success,][added: Success returns] no special[removed: response ]code[removed: will be used].[removed: In case of error, the error codes will be][added: Errors appear] in the standard GraphQL errors array[removed: ][added: .]
Common
Documentation(3)
Documentation
- Changed the description of type
EmployerIdentifiersInput[removed: Employer ][added: Unique employer ]identifier[removed: that uniquely defines][added: . For clients with] an[removed: employer. Clients that have ]Indeed employer key: Other[removed: types of employer identifiers][added: identifier types] are communicated[removed: **individually**][added: individually]. - Changed the description of
inputfieldEmployerIdentifiersInput.type[removed: A magic string that indicates the identifier][added: Identifier] type.[removed: - Otherwise, the type is communicated][added: * Others: Communicated] individually.[removed: ] - Changed the description of type
PatchEmployerInput[removed: To partially update employer attributes: * `{websiteUrl: <not-provided>}`: Does not update the attribute. * `{websiteUrl: null}`: Removes the attribute. * `{websiteUrl: http://example.com}`: Overwrites the attribute with the specified value. For fields that are array types—for example, `sectorSUIDs`: * `{sectorSUIDs: <not-provided>}`: Does not update the attribute. * `{sectorSUIDs: []}`: Removes the attribute. * `{sectorSUIDs: [<some-values>]}`: Overwrites the attribute with the specified values. An example request is: { id: { type: INDEED_EMPLOYER_KEY, id: Employer key }, employerName: Example company, employerAttributes: { countrySpecificAttributes: [{ country: US, sectorSUIDs: [SUID - of - some - indeed - sector] }], localeSpecificAttributes: [{ country: US, language: en, isGlobalDefault: true, description: Description of example company, squareLogo: Base64 - encoded - string }] } } ][added: | Action | Regular fields | Array fields | |:--------|:---------------|:-------------| | Keep unchanged | Omit the field | Omit the field | | Remove value | Set to null | Set to `[]` | | Overwrite | Set new value | Set new array | **Example**: { id: { type: INDEED_EMPLOYER_KEY, id: Employer key }, employerName: Example company, employerAttributes: { countrySpecificAttributes: [{ country: US, sectorSUIDs: [SUID - of - some - indeed - sector] }], localeSpecificAttributes: [{ country: US, language: en, isGlobalDefault: true, description: Description of example company, squareLogo: Base64 - encoded - string }] } }]