v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB

Activity

Create Activity

Creates a Activity object with the given values.

post/api/ats/v1/activities

Headers

x-connector-tokenstring required

Request body

userstring uuid nullable required

The user who owns the activity.

activity_type'NOTE' | 'EMAIL' | 'OTHER' nullable required

The type of activity. If the value is not one of the defined enum values, the original value passed through will be returned.

subjectstring nullable

The subject of the activity.

bodystring nullable required

The body of the activity. This can include notes, comments, or other relevant information.

visibility'ADMIN_ONLY' | 'PUBLIC' | 'PRIVATE' nullable required

Visibility of the activity. If the value is not one of the defined enum values, the original value passed through will be returned.

candidatestring uuid nullable required

Candidate who applied for the activity.

Example request

{
  "user": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "activity_type": "NOTE",
  "subject": "Interview with John Doe",
  "body": "John Doe was interviewed for the position of Software Engineer.",
  "visibility": "PUBLIC",
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
}

Response

Successful Response

{"stackTrail":"paths:/api/ats/v1/activities:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}