---
title: "Create Agency Candidate Activity"
method: POST
path: "/agency/{agency_id}/candidate/{candidate_id}/activity"
tags: ["Agency Candidate Activity"]
---

# Create Agency Candidate Activity

`POST /agency/{agency_id}/candidate/{candidate_id}/activity`

## Request

- Base URL: `http://localhost:3010/v1`
- URL: `http://localhost:3010/v1/agency/{agency_id}/candidate/{candidate_id}/activity`
- Auth: HTTP basic and HTTP basic and HTTP basic

Create an Agency Candidate Activity record

## Request body

- AgencyCandidateActivityBodyParamDef
  - `activity_type` string, required
  - `description` string
  - `comment` string
  - `linked_entities` EntityObject[]
    - `entity_id` string: The id of the entity, note this doesn't have pattern matching as user don't have mongo object ids as ids
    - `entity_type` string, required: The type of the entity this object represents
    - `name` string: The name of the entity

## Response `201`

The agency candidate activity will be returned

- CandidateActivityResponseDef
  - `activity_type` string, required
  - `description` string
  - `subject_candidate_name` string: This is a deprecated property, any value passed on this property will be ignored and will be removed in the future
  - `created_by_user` string: This is a deprecated property, any value passed on this property will be ignored and will be removed in the future
  - `created_by_user_name` string: This is a deprecated property, any value passed on this property will be ignored and will be removed in the future
  - `comment` string
  - `_id` string, required
  - `updated_at` string, date-time, required
  - `created_at` string, date-time, required
  - `__v` integer, required
  - `activity_date` string, date-time, required
  - `linked_entities` EntityObject[]
    - `entity_id` string: The id of the entity, note this doesn't have pattern matching as user don't have mongo object ids as ids
    - `entity_type` string, required: The type of the entity this object represents
    - `name` string: The name of the entity

## Other responses

- `400`: Validation Error. Usually caused by a missing or invalid parameter.
- `401`: Failed to authenticate the user making the request
- `403`: Permission denied error
- `default`: Server error occurred

---

[API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) - [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/revisions/1f079f6b65f5?raw)