---
title: "Generate a new partner"
method: POST
path: "/v1/partner"
tags: ["Partner"]
---

# Generate a new partner

`POST /v1/partner`

Generates a partner based on specified information (CreatePartnerDto)

## Headers

- `Authorization` string

## Request body

- CreatePartnerDto
  - `name` string, required
  - `type` 'consortium' | 'hostAgency' | 'agency', required — Type of partners
  - `email` string
  - `accountManagerEmail` string, required
  - `primaryAdmEmail` string
  - `state` string, required
  - `consortiumName` string
  - `externalId` string
  - `source` object — The source of the data example: salesforce
  - `team` 'west' | 'east' | 'midAmerica' | 'PM' | 'nonUS' — Team of the partner
  - `partnerIdentifier` string — Partner Identifier
  - `api` boolean — Flag indicating if this is an API partner
  - `utm_source` string — UTM source for API partners
  - `utm_medium` string — UTM medium for API partners
  - `insuranceProducts` string[]
  - `defaultInsuranceProduct` string
  - `companySetting` CreateCompanySettingDto
    - `showExtraDetailsFlow` boolean
    - `minDaysFromToday` number
    - `excludedFlowKeys` string[]
  - `parentCompanyExternalId` string

## Response `201`

The partner has been successfully generated.

- CreatePartnerDto
  - `name` string, required
  - `type` 'consortium' | 'hostAgency' | 'agency', required — Type of partners
  - `email` string
  - `accountManagerEmail` string, required
  - `primaryAdmEmail` string
  - `state` string, required
  - `consortiumName` string
  - `externalId` string
  - `source` object — The source of the data example: salesforce
  - `team` 'west' | 'east' | 'midAmerica' | 'PM' | 'nonUS' — Team of the partner
  - `partnerIdentifier` string — Partner Identifier
  - `api` boolean — Flag indicating if this is an API partner
  - `utm_source` string — UTM source for API partners
  - `utm_medium` string — UTM medium for API partners
  - `insuranceProducts` string[]
  - `defaultInsuranceProduct` string
  - `companySetting` CreateCompanySettingDto
    - `showExtraDetailsFlow` boolean
    - `minDaysFromToday` number
    - `excludedFlowKeys` string[]
  - `parentCompanyExternalId` string

## Other responses

- `400` — Validation failed
- `401` — Unauthorized

---

[API](https://skmtc.net/withfaye/apis/faye-partner-sales-api.md) · [All operations](https://skmtc.net/withfaye/apis/faye-partner-sales-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/withfaye/faye-partner-sales-api/versions/e016afb8fdb3/schema)