v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Talent

Post Talent Communication Preferences

Adds or updates communication preferences for the specified talent.

post/v1/talent/{talentId}/communication-preferences

Path parameters

talentIdstring required

The identifier for the talent whose communication preferences should be updated.

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 talent Communication Preference.

talentIdinteger required

The identifier for the talent.

emailboolean

The setting for the talent email preference.

smsboolean

The setting for the talent sms/text messaging preference.

inAppboolean

The setting for the talent in app notification preference.

lastUpdatedstring date-time

The date and time for the talent last updated activity. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

Example request

{
  "id": 2825,
  "talentId": 17845,
  "sms": true,
  "inApp": true
}

Response

The communication preferences for the specified talent.