patchEmployer
Creates or updates an employer.
If input.id matches an existing employer, updates it.
Otherwise, creates an employer.
Returns the employerKey on success.
Protected employers:
Some employers are marked as protected. You can only update:
- Non-protected employers
- Protected employers your client created
Updating a protected employer created by another client returns a FORBIDDEN error.
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. - 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.
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
Response code.
attributeUpdated Boolean! Non-Null
true if employer attributes were updated.
errors [AttributeUpdateError!]! Deprecated Non-Null
List of errors. Empty if none.
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] } }}