Description

Extending Candidates API by starting accepting the key of the application property as an id path parameter (and within the request body) of the following endpoints:

• PUT candidates/{id}/jobs/{jobId}/properties
• PUT candidates/{id}/properties/{propertyId}
• PUT candidates/{id}/jobs/{jobId}/properties/{propertyId}

Extending Candidates API by adding the application property key to the response of the following endpoints:

• GET candidates/{id}/properties
• GET candidates/{id}/jobs/{jobId}/properties

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations. The feature brings new flexibility - the client can use the key of the application property instead of the id to access and manage the application properties data.

References

• Candidates API

Description

Extending Configuration API by starting accepting the key of the application property as an id path parameter of the following endpoints:

• GET configuration/candidate-properties/{id}
• GET configuration/candidate-properties/{id}/values
• POST configuration/candidate-properties/{id}/values
• GET configuration/candidate-properties/{id}/values/{valueId}
• PUT configuration/candidate-properties/{id}/values/{valueId}
• DELETE configuration/candidate-properties/{id}/values/{valueId}

Extending Configuration API by adding the application property key in the response of the following endpoints:

• GET configuration/candidate-properties
• GET configuration/candidate-properties/{id}

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations. The feature brings new flexibility - the client can use the key of the application property instead of the id to access the application property and its values.

References

• Configuration API

Description

SmartOnboard API endpoint to get all activity assignment attachments exposes additional property attachments that is ment to replace old attachmentIds in the future.
Attachment structure aligned with candidate attachments

Example of the response:

{
  "attachmentIds": ["17c206e1-01d6-4738-83ca-e6d5f7614382"],
  "attachments": [
    {
      "id": "17c206e1-01d6-4738-83ca-e6d5f7614382",
      "name": "SR Service Mapping - Service Blueprint Final (1).jpg",
      "contentType": "image/jpeg",
      "actions": {
        "download": {
          "url": "https://api.smartrecruiters.com/smartonboard-api/v202205/activity-assignments/b73755a6-298e-4a62-bba2-737efe8a8f78/attachments/17c206e1-01d6-4738-83ca-e6d5f7614382",
          "method": "GET"
        }
      }
    }
  ]
}

Impact

The new property attachments allows users to get file details attached to activity assignments like file name, content type or URL to download attachment.

References

• Endpoint to get activity assignment attachments

Description

Extending Apply API:

• POST /postings/{uuid}/candidates - Added new optional body object UtmTracking to support tracking the source of the application.
  If present, the UtmTracking must contain utmSource. The remaining fields - utmMedium, utmCampaign, utmContent and utmTerm are optional.

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations.

References

• Apply API

Description

Posting API expose additional property compensation in the response of the following endpoint:

• GET /v1/companies/{companyIdentifier}/postings/{postingId}

It is optional and will be returned only if the posting has compensation information.

Impact

This change is backwards compatible and does not require any changes in the existing clients.

References

• Posting API

Description

Introduced a new field to the Self Scheduling API called meetingHostId. It shows the person who will act as the host for interviews created from self schedule. The host identity will be used to create calendar events and video meetings.
It will be returned if the self schedule has been created with meeting host configured, otherwise it will be null.

It is added to responses of the following endpoints:

• https://developers.smartrecruiters.com/reference/getapplicationselfschedule
• https://developers.smartrecruiters.com/reference/getselfschedule
• https://developers.smartrecruiters.com/reference/searchselfschedules

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations.

References

• Self Schedules API
• Access scopes

Description

As part of improvement of interview templates API, we are deprecating zoomHostId and organizerId fields in creation and update of interview templates API.
In directly it results in the retrieval endpoint to also have these fields deprecated.

Impact

Client should not use zoomHostId and organizerId fields in the requests to create or update interview templates as they are inappropriate at interview templates.
Client should consider meetingHostId for in job interview templates API instead.

References

• Interview Templates API

Description

Introduced a new optional field to the Interview Templates API called meetingHostId. This field can be added to Update job interview template request to specify the person who will act as the host for interviews created from this template. The host identity will be used to create calendar events and video meetings.

The meetingHostId field was also added to the interviewTemplate object in the response of the Find interview templates for job application id endpoint.

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations.

References

• Interview Templates API

Description

Added enriched validation for the LabelTranslation object by requiring at least one non-whitespace character in label field.

This is also reflected in the OpenAPI specification:

    LabelTranslation:
      type: object
      properties:
        label:
          type: string
          minLength: 1
          maxLength: 200
+         pattern: "^(?!\\s*$).+"

This validation is enforced for the request body of the following endpoints:

• PATCH /configuration/job-properties/{id}/values/{valueId}/translations
• PATCH /configuration/job-properties/{id}/translations

Impact

This change is not backwards compatible and will reject requests with translations containing only whitespace characters.
Previously such requests would be accepted.

References

• Configuration API

Description

Added new IP addresses used for outbound traffic from our production environment. The new IP addresses are:

• 18.159.217.255
• 18.156.108.167

Impact

The clients who accept traffic only for SR outbound IPs need to update their firewalls, security groups, or allowlists.
The new IPs will be enabled for use by the production infrastructure three weeks after the publication of this message.

References

• Public IP addresses