/
HA
haekka
/
Snippets API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 19h ago · Updated 4d ago
View markdown
haekka
Snippets API
put
/api/companies/{id}/phishing/settings
v1
latest
Swagger 2.0
BSD License
2026-08-04
346
147
268.3 KB
analytics
1
api
337
delete
/api/answers/quiz/{id}
delete
/api/answers/{id}
delete
/api/answers/{id}/assessment
get
/api/answers/{id}/next_lesson/{employee_uid}
get
/api/assessments/
post
/api/assessments/
get
/api/assessments/company
post
/api/assessments/company
get
/api/assessments/company/{id}
put
/api/assessments/company/{id}
delete
/api/assessments/company/{id}
patch
/api/assessments/company/{id}
get
/api/assessments/{id}
put
/api/assessments/{id}
delete
/api/assessments/{id}
patch
/api/assessments/{id}
post
/api/companies/installations
get
/api/companies/installations/check/{id}
get
/api/companies/installations/{team_id}
get
/api/companies/sync/check/{id}
post
/api/companies/sync/{id}
get
/api/companies/{company_id}/subscription-url
get
/api/companies/{id}/employee/top
get
/api/companies/{id}/employees/curriculums/{curriculum_id}
get
/api/companies/{id}/employees/list
delete
/api/companies/{id}/employees/{employee_id}
put
/api/companies/{id}/employees/{employee_id}/admin
patch
/api/companies/{id}/employees/{employee_id}/admin
get
/api/companies/{id}/engagements/metrics
get
/api/companies/{id}/evdt/analytics/action
get
/api/companies/{id}/evdt/analytics/event
get
/api/companies/{id}/groups
post
/api/companies/{id}/groups
get
/api/companies/{id}/groups/{group_id}
put
/api/companies/{id}/groups/{group_id}
delete
/api/companies/{id}/groups/{group_id}
get
/api/companies/{id}/groups/{group_id}/members/list
get
/api/companies/{id}/home
get
/api/companies/{id}/integrations
delete
/api/companies/{id}/merge/delete/{integration}
patch
/api/companies/{id}/merge/update
get
/api/companies/{id}/notifications/get
get
/api/companies/{id}/notifications/schedule
patch
/api/companies/{id}/notifications/schedule
patch
/api/companies/{id}/notifications/update/
get
/api/companies/{id}/phishing/attacks/{phishing_attack_id}/report
get
/api/companies/{id}/phishing/campaigns
post
/api/companies/{id}/phishing/campaigns
get
/api/companies/{id}/phishing/campaigns/{campaign_id}/actions
get
/api/companies/{id}/phishing/campaigns/{campaign_id}/attacks
delete
/api/companies/{id}/phishing/campaigns/{campaign_id}/delete
get
/api/companies/{id}/phishing/campaigns/{campaign_id}/details
get
/api/companies/{id}/phishing/campaigns/{campaign_id}/details/table
get
/api/companies/{id}/phishing/campaigns/{campaign_id}/details/{employee_id}
put
/api/companies/{id}/phishing/campaigns/{campaign_id}/edit
patch
/api/companies/{id}/phishing/campaigns/{campaign_id}/edit
get
/api/companies/{id}/phishing/campaigns/{campaign_id}/employees
post
/api/companies/{id}/phishing/campaigns/{campaign_id}/launch
delete
/api/companies/{id}/phishing/campaigns/{campaign_id}/remove/{employee_id}
get
/api/companies/{id}/phishing/metrics
get
/api/companies/{id}/phishing/settings
put
/api/companies/{id}/phishing/settings
get
/api/companies/{id}/phishing/whitelist/{template_id}
post
/api/companies/{id}/phishing/whitelist/{template_id}
get
/api/companies/{id}/report
get
/api/companies/{id}/slack-groups
get
/api/companies/{id}/stats
get
/api/companies/{id}/streams/{stream_id}
get
/api/companies/{id}/streams/{stream_id}/posts
get
/api/companies/{id}/streams/{stream_id}/posts/{post_id}
put
/api/companies/{id}/streams/{stream_id}/posts/{post_id}
delete
/api/companies/{id}/streams/{stream_id}/posts/{post_id}
patch
/api/companies/{id}/streams/{stream_id}/posts/{post_id}
put
/api/companies/{id}/streams/{stream}/subscribe
patch
/api/companies/{id}/streams/{stream}/subscribe
delete
/api/companies/{id}/tokens/delete
post
/api/companies/{id}/tokens/generate
get
/api/companies/{id}/tokens/get
get
/api/companies/{id}/trainings
post
/api/companies/{id}/trainings
get
/api/companies/{id}/trainings/list
get
/api/companies/{id}/trainings/renewed/{curriculum_id}
post
/api/companies/{id}/trainings/renewed/{curriculum_id}
get
/api/companies/{id}/trainings/tags
get
/api/companies/{id}/trainings/tags/{tag_id}
put
/api/companies/{id}/trainings/tags/{tag_id}
delete
/api/companies/{id}/trainings/tags/{tag_id}
patch
/api/companies/{id}/trainings/tags/{tag_id}
get
/api/companies/{id}/trainings/{training_id}
put
/api/companies/{id}/trainings/{training_id}
delete
/api/companies/{id}/trainings/{training_id}
patch
/api/companies/{id}/trainings/{training_id}
get
/api/companies/{id}/trainings/{training_id}/before
get
/api/companies/{id}/trainings/{training_id}/lessons
post
/api/companies/{id}/trainings/{training_id}/migrate-training
post
/api/companies/{id}/trainings/{training_id}/publish
post
/api/companies/{id}/trainings/{training_id}/renew
post
/api/companies/{id}/trainings/{training_id}/renew-approve-migration
get
/api/companies/{id}/trainings/{training_id}/statistics
get
/api/companies/{id}/trainings/{training_id}/{employee_id}/getevidence
get
/api/companies/{id}/users_settings
put
/api/companies/{id}/users_settings
delete
/api/companies/{id}/users_settings
patch
/api/companies/{id}/users_settings
get
/api/companies/{id}/workflows
post
/api/companies/{id}/workflows
get
/api/companies/{id}/workflows/{workflow_id}
put
/api/companies/{id}/workflows/{workflow_id}
delete
/api/companies/{id}/workflows/{workflow_id}
patch
/api/companies/{id}/workflows/{workflow_id}
post
/api/companies/{id}/workflows/{workflow_id}/assign
post
/api/companies/{id}/workflows/{workflow_id}/assign/all
get
/api/curriculums/
post
/api/curriculums/
get
/api/curriculums/authors
get
/api/curriculums/tags
get
/api/curriculums/types
get
/api/curriculums/{curriculum_id}/content
get
/api/curriculums/{id}
put
/api/curriculums/{id}
delete
/api/curriculums/{id}
patch
/api/curriculums/{id}
get
/api/curriculums/{id}/catalogDemo
put
/api/curriculums/{id}/catalogDemo
delete
/api/curriculums/{id}/catalogDemo
patch
/api/curriculums/{id}/catalogDemo
get
/api/curriculums/{id}/global
put
/api/curriculums/{id}/global
delete
/api/curriculums/{id}/global
patch
/api/curriculums/{id}/global
put
/api/curriculums/{id}/reorder_content
post
/api/curriculums/{id}/reorder_content
patch
/api/curriculums/{id}/reorder_content
get
/api/employees/channel_engagement/{company_quiz_id}/results
get
/api/employees/email_invitation
post
/api/employees/email_invitation
get
/api/employees/email_invitation/{id}
put
/api/employees/email_invitation/{id}
delete
/api/employees/email_invitation/{id}
patch
/api/employees/email_invitation/{id}
get
/api/employees/employee_lesson/{employee_lesson_id}/lesson_attempt
get
/api/employees/employee_lesson/{employee_lesson_id}/question
post
/api/employees/login
post
/api/employees/login/google
get
/api/employees/quizzes/{company_quiz_id}/anonymous_results
post
/api/employees/quizzes/{company_quiz_id}/channel
post
/api/employees/quizzes/{company_quiz_id}/company
post
/api/employees/quizzes/{company_quiz_id}/okta
get
/api/employees/quizzes/{company_quiz_id}/results
post
/api/employees/quizzes/{company_quiz_id}/selection
post
/api/employees/quizzes/{engagement_id}/send_reminder
get
/api/employees/streams/{stream_id}
post
/api/employees/streams/{stream_id}/channel
post
/api/employees/streams/{stream_id}/company
post
/api/employees/streams/{stream_id}/selection
post
/api/employees/trainings/{curriculum_id}/channel
post
/api/employees/trainings/{curriculum_id}/company
post
/api/employees/trainings/{curriculum_id}/docebo
post
/api/employees/trainings/{curriculum_id}/google
post
/api/employees/trainings/{curriculum_id}/groups
post
/api/employees/trainings/{curriculum_id}/okta
post
/api/employees/trainings/{curriculum_id}/seismic
post
/api/employees/trainings/{curriculum_id}/selection
post
/api/employees/trainings/{curriculum_id}/send_bulk_reminder
post
/api/employees/trainings/{curriculum_id}/send_reminder
post
/api/employees/trainings/{training_id}/alert_employees_of_training
post
/api/employees/trainings/{training_id}/bulk_update
get
/api/employees/trainings/{training_id}/certificate
post
/api/employees/trainings/{training_id}/certificate
post
/api/employees/validate_csv
get
/api/employees/workflow/assigned_all
post
/api/employees/workflow/{employee_workflow_id}/supress
get
/api/employees/workflow/{workflow_id}
post
/api/employees/workflow/{workflow_id}/channel
post
/api/employees/workflow/{workflow_id}/company
post
/api/employees/workflow/{workflow_id}/selection
put
/api/employees/{employee_id}/post/{post_id}
patch
/api/employees/{employee_id}/post/{post_id}
get
/api/employees/{employee_id}/training-assessment/{assessment_id}
get
/api/employees/{employee_id}/training-assessment/{assessment_id}/attempts
post
/api/employees/{employee_id}/training-assessment/{assessment_id}/complete-training
post
/api/employees/{employee_id}/training-assessment/{assessment_id}/question/{question_id}
get
/api/employees/{employee_id}/training-assessment/{assessment_id}/question/{question_id}/attempts
post
/api/employees/{employee_id}/training-assessment/{assessment_id}/retake
get
/api/employees/{employee_id}/training-assessment/{assessment_id}/summary
put
/api/employees/{id}
patch
/api/employees/{id}
get
/api/employees/{id}/details
post
/api/employees/{id}/publish_event
get
/api/employees/{id}/quizzes
post
/api/employees/{id}/quizzes/{employee_weekly_id}/unassign
get
/api/employees/{id}/quizzes/{quiz_id}
post
/api/employees/{id}/quizzes/{quiz_id}
post
/api/employees/{id}/quizzes/{schedule_id}/acknowledge
get
/api/employees/{id}/simple-trainings
post
/api/employees/{id}/streams/{stream_id}/unassign
get
/api/employees/{id}/trainings
put
/api/employees/{id}/trainings/{curriculum_id}/close
patch
/api/employees/{id}/trainings/{curriculum_id}/close
get
/api/employees/{id}/trainings/{training_id}
get
/api/employees/{id}/trainings/{training_id}/attempts
post
/api/employees/{id}/trainings/{training_id}/checkgrade
get
/api/employees/{id}/trainings/{training_id}/items
get
/api/employees/{id}/trainings/{training_id}/lessons
get
/api/employees/{id}/trainings/{training_id}/lessons/{lesson_id}
post
/api/employees/{id}/trainings/{training_id}/lessons/{lesson_id}/question/{question_id}/branching
post
/api/employees/{id}/trainings/{training_id}/lessons/{lesson_id}/question_submit
put
/api/employees/{id}/trainings/{training_id}/renew
patch
/api/employees/{id}/trainings/{training_id}/renew
post
/api/employees/{id}/workflow/{workflow_id}/unassign
get
/api/evdtevents/
post
/api/get_employees_in_stream
post
/api/get_trainings
get
/api/integrations/
get
/api/integrations/docebo/courses
get
/api/integrations/google/groups
get
/api/integrations/merge/{integration}/company/{company_id}/employee/{employee_id}/get_link_token
get
/api/integrations/merge/{integration}/company/{company_id}/get_merge_groups
post
/api/integrations/merge/{integration}/company/{company_id}/remove_merge_integration
post
/api/integrations/merge/{integration}/company/{company_id}/store_access_token
get
/api/integrations/oauth/callback
get
/api/integrations/seismic/content
get
/api/integrations/webhook/{integration}
post
/api/integrations/webhook/{integration}
get
/api/integrations/{id}/company/{company_id}
put
/api/integrations/{id}/company/{company_id}
delete
/api/integrations/{id}/company/{company_id}
patch
/api/integrations/{id}/company/{company_id}
post
/api/integrations/{installation}/company/{company_id}/basic_http_auth
get
/api/integrations/{installation}/company/{company_id}/oauth/url
post
/api/integrations/{installation}/company/{company_id}/oauth/url
post
/api/integrations/{installation}/company/{company_id}/wh_config
get
/api/integrations/{integration}/company/{company_id}/get_webhook_auth_header
post
/api/internal-event-logger
get
/api/lessons/
post
/api/lessons/
post
/api/lessons/lesson_image_upload/
post
/api/lessons/update_lesson_image/
get
/api/lessons/wistia/refresh_token
get
/api/lessons/wistia/update_video_upload
post
/api/lessons/wistia/update_video_upload
delete
/api/lessons/wistia/update_video_upload
get
/api/lessons/{id}
put
/api/lessons/{id}
delete
/api/lessons/{id}
patch
/api/lessons/{id}
get
/api/lessons/{id}/report
post
/api/lessons/{id}/report
post
/api/notifications/snooze_reminder
post
/api/payment/cancel/
post
/api/payment/change-card/
post
/api/payment/change-plan/
get
/api/payment/charges/
post
/api/payment/create-session/
get
/api/payment/current-user/
get
/api/payment/events/
get
/api/payment/invoices/
get
/api/payment/plans/
post
/api/payment/reactivate-subscription/
get
/api/payment/subscription/
post
/api/payment/subscription/
post
/api/payment/v2/create-session/
post
/api/payment/webhook/
get
/api/phishing/categories
get
/api/phishing/imap
put
/api/phishing/imap
get
/api/phishing/imap/test/binding
post
/api/phishing/imap/test/configuration
get
/api/phishing/templates
get
/api/public/employee_trainings/
get
/api/public/employee_trainings/{id}
put
/api/public/employee_trainings/{id}
patch
/api/public/employee_trainings/{id}
get
/api/public/employees/
get
/api/public/employees/{id}/
post
/api/public/phishing/extension/{employee_id}
delete
/api/public/phishing/extension/{employee_id}
post
/api/public/phishing/record/{employee_id}/{campaign_id}/{campaign_attack_id}/{action_type}
get
/api/public/phishing/redirect/{employee_id}/{campaign_id}/{campaign_attack_id}
get
/api/public/status
get
/api/public/trainings/
post
/api/public/trainings/assign/
get
/api/public/trainings/{id}/
get
/api/public/trainings/{id}/evidence
get
/api/questions/quiz
put
/api/questions/quiz
delete
/api/questions/quiz
patch
/api/questions/quiz
delete
/api/questions/quiz/{id}
delete
/api/questions/{id}/assessment
get
/api/quizzes/
post
/api/quizzes/
get
/api/quizzes/company
post
/api/quizzes/company
get
/api/quizzes/company/{id}
put
/api/quizzes/company/{id}
delete
/api/quizzes/company/{id}
patch
/api/quizzes/company/{id}
get
/api/quizzes/company/{id}/schedule/{schedule_id}/evidencereport
get
/api/quizzes/company/{id}/schedule/{schedule_id}/overviewreport
post
/api/quizzes/company/{id}/schedule/{schedule_id}/send_engagement_now
get
/api/quizzes/{company_engagement_id}/check_dynamic_distribution
get
/api/quizzes/{company_engagement_id}/check_engagement_data
post
/api/quizzes/{company_engagement_id}/employee/{employee_id}/post_welcome_message
get
/api/quizzes/{company_engagement_id}/schedules
get
/api/quizzes/{company_quiz_id}/question_statistics
get
/api/quizzes/{id}
put
/api/quizzes/{id}
delete
/api/quizzes/{id}
patch
/api/quizzes/{id}
get
/api/roles/
post
/api/roles/
get
/api/roles/global/{id}
put
/api/roles/global/{id}
delete
/api/roles/global/{id}
patch
/api/roles/global/{id}
post
/api/slack/api
get
/api/streams/
post
/api/streams/
get
/api/streams/categories
post
/api/streams/categories
get
/api/streams/posts
post
/api/streams/posts
get
/api/streams/posts/{id}
put
/api/streams/posts/{id}
delete
/api/streams/posts/{id}
patch
/api/streams/posts/{id}
post
/api/streams/posts/{id}/update
get
/api/streams/{id}
put
/api/streams/{id}
delete
/api/streams/{id}
patch
/api/streams/{id}
get
/api/temporary_data/{data_id}
get
/api/vanta/oauth/callback
get
/api/vanta/oauth/url/{company_id}
post
/api/vanta/sync/{company_id}
post
/api/vanta/uninstall/{company_id}
authenticate_with_slack
1
feature_flags
1
file
1
google_login
1
html_to_pdf
1
signin_with_slack
1
slack
1
wistia_web_hook
1
api
put
/api/companies/{id}/phishing/settings
Request body
PhishingCompanySettings
required
id
string
uuid
company
string
uuid
forwarding_emails
string[]
nullable
phishing_email_forwarded_notification_emails
string[]
nullable
imap_ssl_host
string
nullable
imap_ssl_port
string
nullable
Response
OK
PhishingCompanySettings
required
id
string
uuid
company
string
uuid
forwarding_emails
string[]
nullable
phishing_email_forwarded_notification_emails
string[]
nullable
imap_ssl_host
string
nullable
imap_ssl_port
string
nullable