Skip to content

Create Activities

Endpoint

http
POST /unified/ats/activities
Integrations supported
  • Lever
  • Recruitee

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

candidate_id
string
The ID of the candidate to create the note for.
Required in
  • Lever
  • Recruitee
body
string
The activity's body
Required in
  • Recruitee
Supported in
  • Lever
visibility
string
The activity's visibility
All possible enum values:
  • private
  • public
  • admin_only
Supported in
  • Lever
created_at
string · date-time
The date and time of the activity's creation
Supported in
  • Lever
remote_data
object
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

id
string
REQUIRED · The activity's unique identifier
candidate
object
The activity's candidate
id
string
Unique identifier of the candidate
actor
object
The activity's actor
id
string
Unique identifier of the actor
type
string
Type of the actor
All possible enum values:
  • user
  • candidate
activity_type
string
The activity's type
All possible enum values:
  • note
  • email
from
object[]
From email addresses if the activity_type is email
email
string
Email of the sender
name
string
Name of the sender
to
object[]
email
string
Email of the recipient
name
string
Name of the recipient
cc
object[]
email
string
Email of the recipient
name
string
Name of the recipient
subject
string
The activity's subject
body
string
The activity's body
visibility
string
The activity's visibility
All possible enum values:
  • private
  • public
  • admin_only
updated_at
string · date-time
The date and time of the activity's last update
created_at
string · date-time
The date and time of the activity's creation
remote_data
object
Raw data returned from the remote API call.