---
title: "Creates a candidate widget for a specific agency group"
method: POST
path: "/agency-group/{agency_group_id}/candidate-widgets"
tags: ["Agency Group Candidate Widgets"]
---

# Creates a candidate widget for a specific agency group

`POST /agency-group/{agency_group_id}/candidate-widgets`

## Request

- Base URL: `http://localhost:3010/v1`
- URL: `http://localhost:3010/v1/agency-group/{agency_group_id}/candidate-widgets`
- Auth: HTTP basic

## Request body

- CandidateWidgetsPayloadDef
  - `type` 'welcome-widget' | 'legacy_dbs', required
  - `content` string, required
  - `candidate_types` string[], required
  - `candidate_statuses` string[], required
  - `status` 'active' | 'inactive', required

## Response `201`

Created candidate widget for a agency group will be returned

- AgencyGroupCandidateWidgetResponseDef
  - `_id` string, required
  - `updated_at` string, date-time, required
  - `created_at` string, date-time, required
  - `__v` integer, required
  - `type` 'welcome-widget' | 'legacy_dbs', required
  - `content` string, required
  - `candidate_types` string[], required
  - `candidate_statuses` string[], required
  - `status` 'active' | 'inactive', required
  - `agency_group_id` string, required

## Other responses

- `400`: Validation error on get
- `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)