2025-08-21

GraphQL schema change log: 2025-08-21

📘 Documentation: Updated the GraphQL schema and the GraphQL API Reference with these changes:
- ✖ Field atsApplicationId was removed from object type AtsSyncCandidateSyncApplicationVersionStatus
- ✖ Field atsCandidateId was removed from object type AtsSyncCandidateSyncApplicationVersionStatus
- ✖ Field indeedRegistrationId was removed from object type AtsSyncCandidateSyncApplicationVersionStatus
- ✖ Field jobMetadata was removed from object type AtsSyncCandidateSyncApplicationVersionStatus
- ✖ Input field applicationIdentifier of type AtsSyncCandidateSyncApplicationIdentifierInput! was added to input object type DeleteAtsSyncCandidateSyncApplicationInput
- ✖ Input field atsApplicationId was removed from input object type DeleteAtsSyncCandidateSyncApplicationInput
- ✖ Input field atsCandidateId was removed from input object type DeleteAtsSyncCandidateSyncApplicationInput
- ✖ Input field indeedRegistrationId was removed from input object type DeleteAtsSyncCandidateSyncApplicationInput
- ✖ Input field jobMetadata was removed from input object type DeleteAtsSyncCandidateSyncApplicationInput
- ✖ Input field applicationIdentifier of type AtsSyncCandidateSyncApplicationIdentifierInput! was added to input object type InitializeAtsSyncCandidateSyncApplicationInput
- ✖ Input field atsApplicationId was removed from input object type InitializeAtsSyncCandidateSyncApplicationInput
- ✖ Input field atsCandidateId was removed from input object type InitializeAtsSyncCandidateSyncApplicationInput
- ✖ Input field indeedRegistrationId was removed from input object type InitializeAtsSyncCandidateSyncApplicationInput
- ✖ Input field jobMetadata was removed from input object type InitializeAtsSyncCandidateSyncApplicationInput
- ✖ Field admin1Code was removed from object type JobLocation
- ✖ Field admin2Code was removed from object type JobLocation
- ✖ Field admin3Code was removed from object type JobLocation
- ✖ Field admin4Code was removed from object type JobLocation
- ✔ Type AtsSyncCandidateSyncApplicationIdentifier was added
- ✔ Field applicationIdentifier was added to object type AtsSyncCandidateSyncApplicationVersionStatus
- ✔ Field AttributeUpdateError.detail description, changed from:
```
Detail that helps understand the error.
```
  To:
```
Details about the error.
```
- ✔ Field AttributeUpdateError.message description, changed from:
```
A short message describes the error. 
```
  To:
```
A short message that describes the error.
```
- ✔ Field AttributeUpdateError.suggestion description, changed from:
```
Suggestion that helps recover from the error.
```
  To:
```
Suggestion to help recover from the error.
```
- ✔ Description:
```
Standard GraphQL error code described in [API Recommendations]
(https://api-wg.pages.corp.indeed.com/api-recommendations/recommendations/graphql/errors/errors/#must-report-standardized-error-codes-for-commonly-encountered-errors-229)
on type AttributeUpdateResponseCode
```
  Has changed to:
```
Standard GraphQL error code that [MUST report standardized error codes for
commonly encountered errors [229]]
(https://api-wg.pages.corp.indeed.com/api-recommendations/recommendations/graphql/errors/errors/#must-report-standardized-error-codes-for-commonly-encountered-errors-229)
describes.
```
- ✔ Description for enum value AttributeUpdateResponseCode.BAD_USER_INPUT changed from:
```
The value of an input parameter is invalid. This error code applies to input
validation performed beyond the standard GraphQL client and server
libraries Non-Null and type checking.
```
  To:
```
The value of an input parameter is invalid. This error code applies to input
validation performed beyond the standard GraphQL client and server
libraries non-null and type checking.
```
- ✔ Description for enum value AttributeUpdateResponseCode.FORBIDDEN changed from:
```
Valid authentication credentials are present but insufficient to perform the
associated operation. This error code is the GraphQL equivalent of the HTTP
response status 403 Forbidden.
```
  To:
```
Valid authentication credentials are present but insufficient to perform the
associated operation. This error code is the GraphQL equivalent of the HTTP
`403 Forbidden` response status code.
```
- ✔ Description for enum value AttributeUpdateResponseCode.INTERNAL_SERVER_ERROR changed from:
```
The server encountered an unexpected failure and did not provide a response.
Use this generic error only for failures that the server cannot handle.
```
  To:
```
The server encountered an unexpected failure and did not provide a response.
Use this generic error for failures that the server cannot handle.
```
- ✔ Description for enum value AttributeUpdateResponseCode.PARTIAL_SUCCESS changed from:
```
Its partial-success if the response contains only part of successful
response because of some failures.
```
  To:
```
Partial-success if the response contains only part of successful response
because of some failures.
```
- ✔ Description for enum value AttributeUpdateResponseCode.UNAUTHENTICATED changed from:
```
The operation was not attempted because the request did not include
sufficient authentication credentials for the operation. This error code is
the GraphQL equivalent of the HTTP response status 401 Unauthorized.
```
  To:
```
The operation was not attempted because the request did not include
sufficient authentication credentials for the operation. This error code is
the GraphQL equivalent of the HTTP `401 Unauthorized` response status
code.
```
- ✔ Input field CountrySpecificEmployerAttributesInput.country description, changed from:
```
An ISO 3166-1 - alpha 2 encoded country code string, e.g. US, JP.
```
  To:
```
An ISO 3166-1 - alpha 2-encoded country code string, such as, `US` or `JP`.
```
- ✔ Input field CountrySpecificEmployerAttributesInput.employees description, changed from:
```
The size of the employers workforce.

Allowed values:
- ERv1_1:          1 employee
- ERv1_2_10:       2-10 employees
- ERv1_11_50:      11-50 employees
- ERv1_1_50:       1-50 employees
- ERv1_51_200:     51-200 employees
- ERv1_201_500:    201-500 employees
- ERv1_501_1000:   501-1000 employees
- ERv1_1001_5000:  1001-5000 employees
- ERv1_5001_10000: 5001-10000 employees
- ERv1_10000_PLUS: 10000+ employees 
```
  To:
```
Size of the employers workforce.

Allowed values 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    |
```
- ✔ Input field CountrySpecificEmployerAttributesInput.isGlobalDefault description, changed from:
```
If the data is supposed to be used as global default, set
isGlobalDefault=true. If isGlobalDefault=true is set, beside its normal
locale, data will also be written to ww_WW internally. This field is
deprecated because it will always be true for
CountrySpecificEmployerAttributes.
```
  To:
```
Deprecated. If the data the global default, set `isGlobalDefault=true`. If
`isGlobalDefault=true` in addition to its normal locale, data is also
written to `ww_WW` internally. This field is deprecated because it is
always `true` for `CountrySpecificEmployerAttributes`.
```
- ✔ Input field CountrySpecificEmployerAttributesInput.phoneNum description, changed from:
```
Official Phone Number of the employer. This field is deprecated, please use
phoneNumber field instead.
```
  To:
```
Deprecated. Employers official phone number. Use the `phoneNumber` field
instead.
```
- ✔ Input field CountrySpecificEmployerAttributesInput.phoneNumber description, changed from:
```
Official Phone Number of the employer.
```
  To:
```
Employers official phone number.

The value must follow the standard [E.164](https://en.wikipedia.org/wiki/E.164) format. 
For example, `+17895551234`.
```
- ✔ Input field CountrySpecificEmployerAttributesInput.sectorSUIDs description, changed from:
```
A list of Indeed sector (industry) SUIDs. Each value must be a valid
SUID&mdash;see the following table.

**Market-specific documentation**

|Market|Guidance|
|-|-|
|Japan|[Valid company sector SUID values](https://docs.indeed.com/employer/reference/company-sector)| 
```
  To:
```
List of Indeed sector (industry) short unique identifiers (SUIDs). 

The maximum number of SUIDs is 3. Each value must be a valid SUID. 

See this table:

**Market-specific documentation**

| Market | Example value |
|:-------|:--------------|
| Japan  | [Valid company sector SUID values](https://docs.indeed.com/indeed-plus/employer-data-api/reference/company-sector). |
```
- ✔ Input field CountrySpecificEmployerAttributesInput.taxId description, changed from:
```
Tax identifier of the employer.

Limited to 100 chars.

**Market-specific documentation**

|Market|Example value|
|-|-|
|Japan|Use the 法人番号. If `employerType=JURIDICAL_PERSON`, fill in this field with 法人番号 whenever possible. It is necessary to correctly identify a company. If `employerType=NATURAL_PERSON`, this field is optional.| 
```
  To:
```
Employers tax identifier.

Limit is 100 characters.

**Market-specific documentation**

| Market | Example value |
|:-------|:--------------|
| Japan | If [`employerType`](/api/employer/objects/EmployerAttributesInput) is `JURIDICAL_PERSON`, set this field to the corporate number (法人番号) to correctly identify the company.<br/><br/>If `employerType` is `NATURAL_PERSON`, this field is optional. |
```
- ✔ Input field CountrySpecificEmployerAttributesInput.websiteUrl description, changed from:
```
The root website of the employer&mdash;for example, `indeed.com`. If the
employer is a franchise, use the brand website.

Limited to 400 chars. Must be a valid URL. 
```
  To:
```
The root website of the `employer`&mdash;for example, `indeed.com`. If the
employer is a franchise, use the brand website.

Limit is 400 characters. Must be a valid URL.
```
- ✔ Description:
```
Each attribute in this input type is an employer attribute that can be
updated on type EmployerAttributesInput
```
  Has changed to:
```
Input object that contains employer attributes that you can update.
```
- ✔ Input field EmployerAttributesInput.countrySpecificAttributes description, changed from:
```
Employer attributes that can be different based on the country.
```
  To:
```
Employer attributes that can differ by country.
```
- ✔ Input field EmployerAttributesInput.employerType description, changed from:
```
Type of the employer.

**Market-Specific documentation**

|Market|Example value|
|-|-|
|Japan|Use the field to specify 企業区分: 法人 or 個人|
```
  To:
```
Employer type.

**Market-specific documentation**

| Market | Example value |
|:-------|:--------------|
| Japan  | Use the field to specify 企業区分: 法人 or 個人. |
```
- ✔ Input field EmployerAttributesInput.localeSpecificAttributes description, changed from:
```
Employer attributes that can be different based on the locale (lang + country).
```
  To:
```
Employer attributes that can differ by locale (`lang` + `country`).
```
- ✔ Description:
```
Employer identifier that uniquely defines an employer.

Clients that have Indeed employer key.
```

GraphQL schema change log: 2025-08-21​

Was this page helpful?

GraphQL schema change log: 2025-08-21