v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Add a Talent Tag

Add tags to the talent. Added tags display on the Tags tab of the talent profile page. Tags may comprise the information that can help to further categorize the talent and make their profile more searchable.

post/v1/talent/{talentId}/talenttag

Path parameters

talentIdstring required

The identifier for the talent record to which the tag should be added.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

talentTagIdinteger

The identifier for the Talent Tag.

talentIdinteger required

The identifier for the talent.

tagIdinteger

The identifier for the Talent Tag option.

tagstring required

The text of the Talent Tag option.

detailIdinteger

The identifier for the details option.

detailstring required

The text of the details option.

expirationDatestring date-time

The expiration date of the Talent Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

Example request

{
  "talentTagId": 4283,
  "talentId": 124785,
  "tagId": 552,
  "tag": "Language",
  "detailId": 782,
  "detail": "Spanish"
}

Response

The created talent tag.

talentTagIdinteger

The identifier for the Talent Tag.

talentIdinteger required

The identifier for the talent.

tagIdinteger

The identifier for the Talent Tag option.

tagstring required

The text of the Talent Tag option.

detailIdinteger

The identifier for the details option.

detailstring required

The text of the details option.

expirationDatestring date-time

The expiration date of the Talent Tag. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

Example response

{
  "talentTagId": 4283,
  "talentId": 124785,
  "tagId": 552,
  "tag": "Language",
  "detailId": 782,
  "detail": "Spanish"
}