patchEmployer

Creates or updates an employer.

• If input.id matches an existing employer, updates the employer.
• If not, creates an employer.
• On success, the deprecated employerKey field is empty. Clients must not use it.

Protected employers

You can update:

• Non-protected employers
• Protected employers created by your client

If you try to update a protected employer created by another client, the API returns FORBIDDEN.

Timeout

Set a 5,000 ms timeout for Indeed PLUS API calls.

---

Arguments

input PatchEmployerInput! Required

id EmployerIdentifiersInput! Required

Globally unique IRI for the employer.

type String! Required

Identifier type.

• Indeed internal clients: See valid types in EmployerIdentifierType (opens in a new window).
• Others: Communicated individually.

id ID! Required

ID.

employerName String

Official employer name. Required to create an employer key. Optional for submitting employer data.

Limits: 255 UTF-16 characters. No email addresses or 8+ consecutive digits.

employerName is copied to the global localizedName field unless explicitly set in the request.

employerAttributes EmployerAttributesInput

Employer attributes to update. If null, nothing is updated.

employerType EmployerType

Employer type.

Japan: Specify 企業区分 (法人 or 個人).

countrySpecificAttributes [CountrySpecificEmployerAttributesInput!]

Country-specific employer attributes.

localeSpecificAttributes [LocaleSpecificEmployerAttributesInput!]

Locale-specific employer attributes (lang + country).

jpNewGradsAttributes JpNewGradsEmployerAttributesInput

JP new grads employer attributes.

Response

Returns PatchEmployerPayload .

responseCode AttributeUpdateResponseCode! Deprecated Non-Null

Deprecated legacy response code. Successful responses return OK.

Errors appear in the standard GraphQL errors array. See Use standard error codes for common errors.

attributeUpdated Boolean! Non-Null

true if employer attributes were updated.

errors [AttributeUpdateError!]! Deprecated Non-Null

List of errors. Empty if none.

message String! Deprecated Non-Null

Short error message.

detail String Deprecated

Error details.

suggestion String Deprecated

Recovery suggestion.

Example

Query

mutation PatchEmployer($input: PatchEmployerInput!) {
  patchEmployer(input: $input) {
    responseCode
    attributeUpdated
    errors {
      message
      detail
      suggestion
    }
  }
}

Variables

{"input": PatchEmployerInput}

Response

{
  "data": {
    "patchEmployer": {
      "responseCode": "OK",
      "attributeUpdated": true,
      "errors": [AttributeUpdateError]
    }
  }
}

 

Was this page helpful?