v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Talent

Add Citizenship

Adds a citizenship tag or a custom tag the company would like to use for the specified talent record. Added tag is displayed on the Tags tab of the talent’s profile page.

post/v1/talent/{talentId}/citizenship

Path parameters

talentIdstring required

The identifier for the talent record to which the Citizenship 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

idinteger

The identifier for the Citizenship Tag.

talentIdinteger required

The identifier for the talent.

citizenshipIdinteger

The identifier for the Citizenship option.

citizenshipNamestring required

The name of the Citizenship option.

expirationDatestring date-time

The expiration date of the Citizenship 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

{
  "id": 1837,
  "talentId": 16745,
  "citizenshipId": 843,
  "citizenshipName": "Citizen"
}

Response

The newly created citizenship tag.