---
title: "create projects"
method: POST
path: "/sample/v1/projects"
tags: ["projects"]
---

# create projects

`POST /sample/v1/projects`

## Request body

- Project
  - `category` ProjectCategoryData, required
    - `studyRequirements` string[] — List of survey requirements
    - `studyType` string[] — List of survey types
    - `surveyTopic` string[], required — List of survey topics
  - `devices` string[] — List of emails to subscribe to notifications
  - `exclusions` ExclusionData
    - `list` string[], required — List of all the type values
    - `type` 'PROJECT' | 'CATEGORY', required — Type of exclusion inclusion
  - `extProjectId` string, required — Unique external project ID
  - `jobNumber` string — Project job number
  - `lineItems` LineItemData[], required — List of line items for the project.
    - `channelDistribution` ChannelDistribution
      - `integratedChannelPercent` integer — percent of integrated channel distribution (sum of open, loyalty and integrated should be 100)
      - `loyaltyChannelPercent` integer — percent of loyalty channel distribution (sum of open, loyalty and integrated should be 100)
      - `openChannelPercent` integer — percent of open channel distribution (sum of open, loyalty and integrated should be 100)
    - `costPerInterview` number, double — Client specified CPI for the line item
    - `countryISOCode` string, required — ISO country code
    - `daysInField` integer — Duration of the project in days.
    - `deliveryType` string — Delivery type: SLOW, BALANCED,FAST or BURST.
    - `dynataLineItemReferenceId` string — Sales Order Detail Reference ID
    - `extLineItemId` string, required — Unique line item Id
    - `fieldSchedule` FieldSchedule
      - `endTime` string — Date and time at which the fielding is expected to end in UTC timezone
      - `startTime` string — Date and time at which the fielding is expected to start in UTC timezone
    - `indicativeIncidence` number, double, required — Expected incidence of the survey
    - `languageISOCode` string, required — ISO language code
    - `lengthOfInterview` integer, required — expected duration of the survey in minutes
    - `quotaPlan` QuotaPlanData
      - `filters` TargetingAttribute[] — Filters are attributes which all panelists should have before qualifying for a survey
        - `attributeId` string, required — Id of the attribute
        - `operator` 'INCLUDE' | 'EXCLUDE' | 'include' | 'exclude' — option to exclude or include the options for the particular feature id
        - `options` string[], required — Options for the attribute
      - `quotaGroups` QuotaGroupData[] — Quota groups define the allocated targeting attributes for panelists within this line item
        - `name` string — name or desciption of the quota group.
        - `quotaCells` QuotaCell[], required — List of quotas
          - `count` integer — number of the total completes for this cell
          - `externalQuotaCellId` string — external ID of the quota cell
          - `perc` number, double — percentage of the total completes for this cell
          - `quotaCellId` string — ID of the quota cell
          - `quotaNodes` TargetingAttribute[] — nodes in the cell.
            - `attributeId` string, required — Id of the attribute
            - `operator` 'INCLUDE' | 'EXCLUDE' | 'include' | 'exclude' — option to exclude or include the options for the particular feature id
            - `options` string[], required — Options for the attribute
          - `status` 'LAUNCHED' | 'PAUSED' — status of the quota cell
        - `quotaGroupId` string — ID of the quota group
    - `requiredCompletes` integer — Number of complete required for the line item
    - `sources` LineItemSource[] — id of the source where is the sample coming from
      - `id` integer — id of the source where is the sample coming from
      - `name` string — name of the source where is the sample coming from
    - `surveyTestURL` string — Entry link for the user.
    - `surveyTestURLParams` URLParam[] — SurveyTestURL Params of the line item.
      - `key` string, required — key of the URL
      - `values` string[], required — values for the URL key
    - `surveyTestingNotes` string — Survey testing notes
    - `surveyURL` string — Entry link for the user.
    - `surveyURLParams` URLParam[] — SurveyURL Params of the line item.
      - `key` string, required — key of the URL
      - `values` string[], required — values for the URL key
    - `targets` Target[] — Data of completes/starts required for the line item
      - `count` integer, required — requiredCompletes for COMPLETE target type.
      - `dailyLimit` integer — target value for dailyLimit
      - `softLaunch` integer — target value for softLaunch
      - `type` 'COMPLETE', required — target type can be starts/completes.
    - `title` string, required — A title for the line item
  - `notificationEmails` string[] — List of emails to subscribe to notifications
  - `respondentFilters` RespondentFilterData[] — Inclusion/Exclusions on the project
    - `dispositions` string[] — Dispositions
    - `list` string[], required — List of all the type values
    - `schedule` Schedule
      - `endDate` string — End date for custom schedule type
      - `startDate` string — Start date for custom schedule type
      - `type` 'ALL_DATES' | 'LAST_DAYS' | 'LAST_MONTHS' | 'CUSTOM' — Type of schedule
      - `value` integer — The number of past days/months before
    - `type` 'PROJECT' | 'CATEGORY', required — Type of exclusion
  - `title` string, required — Project title
  - `useRelevantId` boolean — set to true to dedupe using relevant id

## Response `200`

OK

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/dynata/apis/sample-api.md) · [All operations](https://skmtc.dev/dynata/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dynata/sample-api/revisions/b3b54de87dfc/schema)