v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Create a Talent Activity

Adds a talent activity record for the specified talent. The added activity is displayed on the Activities tab of the talent profile page.

post/v1/talent/{talentId}/activity

Path parameters

talentIdstring required

An identifier for the talent whose activity is being 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

typeIdinteger required

The identifier for the activity type.

namestring

The name of the activity type.

show_ininteger

An indicator of which activity type group the current activity type should be included in. Allowed values: -2 for Archived Activities/Tasks, -1 for All Activities/Tasks, 0 for Custom Tasks/Activities, 1 for Activities, 2 for Tasks. A value of -2 cannot be submitted when creating an activity.

activityDatestring date-time

The date of the talent's 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. If the timestamp includes a Z (e.g., YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ), it indicates UTC time. For example, 2024-12-01, 2024-12-01T14:30:00, 2024-12-01T14:30:00.546, 2024-12-01T14:30:00Z, and 2024-12-01T14:30:00.546Z.

talentIdinteger required

The identifier for the talent.

idinteger

The identifier for the talent activity.

notesstring

The talent activity notes.

userIdinteger

The identifier for the user who logged the activity.

Example request

{
  "typeId": 284,
  "name": "Interview completed",
  "show_in": 1,
  "talentId": 283287,
  "id": 53892,
  "notes": "Need to call.",
  "userId": 42948
}

Response

The created talent activity.

typeIdinteger required

The identifier for the activity type.

namestring

The name of the activity type.

show_ininteger

An indicator of which activity type group the current activity type should be included in. Allowed values: -2 for Archived Activities/Tasks, -1 for All Activities/Tasks, 0 for Custom Tasks/Activities, 1 for Activities, 2 for Tasks. A value of -2 cannot be submitted when creating an activity.

activityDatestring date-time

The date of the talent's 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. If the timestamp includes a Z (e.g., YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ), it indicates UTC time. For example, 2024-12-01, 2024-12-01T14:30:00, 2024-12-01T14:30:00.546, 2024-12-01T14:30:00Z, and 2024-12-01T14:30:00.546Z.

talentIdinteger required

The identifier for the talent.

idinteger

The identifier for the talent activity.

notesstring

The talent activity notes.

userIdinteger

The identifier for the user who logged the activity.

Example response

{
  "typeId": 284,
  "name": "Interview completed",
  "show_in": 1,
  "talentId": 283287,
  "id": 53892,
  "notes": "Need to call.",
  "userId": 42948
}