---
title: "Create candidate notification for the given context type"
method: POST
path: "/agency/{agency_id}/candidate/{candidate_id}/notifications"
tags: ["Agency Candidate Notifications"]
---

# Create candidate notification for the given context type

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

## Request

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

## Headers

- `Authorization` string, string, required
- `Context` string, string, required
- `Accept` 'application/json', required
- `X-Accept-Timezone` string

## Request body

- object
  - `type` string, required
  - `data` object, required

## Response `201`

The candidate notification resource response

- object
  - `_id` string, required
  - `updated_at` string, date-time, required
  - `created_at` string, date-time, required
  - `__v` integer, required
  - `status` 'new' | 'opt_out' | 'not_configured' | 'processing' | 'completed' | 'dispatched', required
  - `context_type` 'agency' | 'agency-group', required
  - `context_type_id` string, required
  - `candidate_id` string, required
  - `notification_type` string, required
  - `version` integer, required
  - `external_tokens` object[]
    - `token` string, required
    - `value` string, required
  - `activity_data` object
    - `description` string
    - `comment` string
    - `linked_entities` object[]
      - `entity_type` string, required
      - `entity_id` string, required
  - `linked_entities` object[]
    - `entity_type` string, required
    - `entity_id` string, required
  - `meta_data` object

## Other responses

- `400`: Candidate notification validation response definition
- `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)