---
title: "POST /api/companies/{id}/phishing/campaigns"
method: POST
path: "/api/companies/{id}/phishing/campaigns"
tags: ["api"]
---

# POST /api/companies/{id}/phishing/campaigns

`POST /api/companies/{id}/phishing/campaigns`

## Request body

- PhishingCampaign
  - `id` string, uuid
  - `active` boolean
  - `name` string, required
  - `templates` PhishingTemplate[], required
    - `id` string, uuid
    - `application` string, nullable
    - `name` string, required
    - `icon` string, nullable
    - `preview_image_url` string, required
    - `html_url` string, required
    - `active` boolean
    - `sender_email_address` string, required
    - `category` PhishingTemplateCategory, required
      - `id` string, uuid
      - `name` string, required
  - `send_option` 'once_immediately' | 'randomly_once_every_two_weeks' | 'randomly_once_monthly' | 'randomly_once_quarterly' | 'randomly_once_every_six_months' | 'randomly_once_yearly', nullable
  - `skip_weekends` boolean
  - `last_sent_date` string, date-time, nullable
  - `channels_to_sync` string[], nullable
  - `slack_auto_enroll` boolean, nullable

## Response `201`

Created

- PhishingCampaign
  - `id` string, uuid
  - `active` boolean
  - `name` string, required
  - `templates` PhishingTemplate[], required
    - `id` string, uuid
    - `application` string, nullable
    - `name` string, required
    - `icon` string, nullable
    - `preview_image_url` string, required
    - `html_url` string, required
    - `active` boolean
    - `sender_email_address` string, required
    - `category` PhishingTemplateCategory, required
      - `id` string, uuid
      - `name` string, required
  - `send_option` 'once_immediately' | 'randomly_once_every_two_weeks' | 'randomly_once_monthly' | 'randomly_once_quarterly' | 'randomly_once_every_six_months' | 'randomly_once_yearly', nullable
  - `skip_weekends` boolean
  - `last_sent_date` string, date-time, nullable
  - `channels_to_sync` string[], nullable
  - `slack_auto_enroll` boolean, nullable

---

[API](https://skmtc.net/haekka/apis/snippets-api.md) · [All operations](https://skmtc.net/haekka/apis/snippets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/haekka/snippets-api/revisions/2a72ba99e389/schema)