v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Talent

Remove Citizenship

Permanently deletes the specified citizenship tag or custom tag for the specified talent record from their profile.

delete/v1/talent/{talentId}/citizenship

Path parameters

talentIdstring required

The identifier for the talent record for which the Citizenship tag should be removed.

Query parameters

itemIdstring required

The identifier for the Citizenship tag being removed.

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.

Response

The citizenship tag that was removed.

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 response

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