Changelog
Start typing to search…

Interview Templates API - Added repeat configuration

Description

Introduced a new field to the Interview Templates API called repeat. This field configures when and how many times a candidate should be prompted to select a time slot for an interview if they haven't already done so. If not provided, the default behavior is to not repeat the prompt.

It is added to request of the following endpoints:

Impact

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

References

Self Scheduling API - Added repeat configuration

Description

Introduced a new field to the Self Scheduling API called repeat. This field configures when and how many times a candidate should be prompted to select a time slot for an interview if they haven't already done so. If not provided, the default behavior is to not repeat the prompt.

It is added to request of the following endpoints:

Impact

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

References

Jobs API - Extend job ad creation by adding `includeInternal` request parameter

Description

Extending Jobs API by adding new optional boolean request parameter includeInternal to include internal sources when publishing jobAd. The following endpoints are impacted:

  • POST jobs/{jobId}/jobads/{jobAdId}/postings
  • POST jobs/{jobId}/publication

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations. This feature allows clients to include/exclude internal sources when publishing jobAds. If the includeInternal parameter is not specified, the default behavior is to include internal sources.

References

Candidates API - Expose Application Property Key

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

Configuration API - Expose Application Property Key

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

SmartOnboard API - add new attachments property to activity assignment

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

Apply API - Added UTM Parameters

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

Posting API - Expose compensation in posting details

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

Self Scheduling API - Added Meeting Host ID

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:

Impact

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

References

Interview Templates API - Deprecation of ZOOM Host ID and Organizer ID

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