--- title: "Create a proposal" method: POST path: "/proposals/CreateProposal" tags: ["Proposals"] --- # Create a proposal `POST /proposals/CreateProposal` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/proposals/CreateProposal` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Creates a proposal and returns its ID in the response. Once a proposal is created via API, an email is sent to the addressees listed in the `notificationEmails` parameter and a proposal appears in the ServiceChannel system. Use the response model of the [GET /proposals/CheckProposalCreation](https://developer.servicechannel.com/swagger/index.html#/Proposals/GETv3_proposals_CheckProposalCreation%3FSubscriberId%3D%7BSubscriberId%7D%26ProviderId%3D%7BProviderId%7D%26LocationId%3D%7BLocationId%7D%26TradeId%3D%7BTradeId%7D%26Currency%3D%7BCurrency%7D) method as a request model.
***Note***: To run the method, subscriber users should possess one or a combination of the following permissions and roles: *Proposals: Create* permission, * Proposals:Full Control* permission, *Power User* role, *Power User Light* role. When provider users are eligible to create proposals via UI, they can also create proposals via API. Find out more about [creating a proposal](https://servicechannel.atlassian.net/wiki/spaces/SCUCP/pages/619217044/Creating+a+Proposal) in ServiceChannel University.
***Note***: Custom proposal forms are not supported.
**Example Request** POST /proposals/CreateProposal { "version": "1.0.0", "subscriberId": 2014917243, "providerId": 2000090505, "locationId": 2016322567, "tradeId": 90480, "currency": "USD", "proposalNumber": "pr57820456142079", "description": "Motor Replacement", "notificationEmails": "", "costsIncurredToDate": [], "materials": [ {"description": "Motor Assembly Unit", "unit": "each", "qty": 1, "price": 1450.00}, {"description": "Electrical Components Kit", "unit": "each", "qty": 1, "price": 180.50}, { "description": "Fan Blade Component", "unit": "each", "qty": 1, "price": 320.75}, { "description": "Capacitor Unit", "unit": "each", "qty": 1, "price": 95.25} ], "materialsAnswer": "New", "installationLabor": [ {"description": "Regular Service Hours", "tech": 1, "hours": 10, "rate": 95.00}, { "description": "Overtime Service Hours", "tech": 0, "hours": 0, "rate": 0}, { "description": "Holiday Service Hours", "tech": 0, "hours": 0, "rate": 0}, { "description": "Helper Standard Hours", "tech": 0, "hours": 0, "rate": 0}, { "description": "Helper Overtime Hours", "tech": 0, "hours": 0, "rate": 0}, { "description": "Helper Holiday Hours", "tech": 0, "hours": 0, "rate": 0}, { "description": "External Labor Support", "tech": 0, "hours": 0, "rate": 0} ], "installationLaborFlatFeeLabor": 0, "nonInstallationExpenses": { "travel": { "ofTrips": 2, "charge": 85.00}, "fees": 0, "nonInstallationLabor": 0 }, "nonInstallationExpensesOther": [], "freight": 140.00, "freightOther": [], "tax": { "materialSalesTax": 0, "installationLaborSalesTax": 0, "nonInstallationExpensesSalesTax": 0, "freightTax": 0 } } ## Request body - SystemObject ## Response `200` A proposal is successfully created. - string ## Other responses - `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
Error codes: 503 — JSON is invalid or corrupted 503 — Version is required 503 — Template version is incorrect 503 — Proposal form is not supported via API. Please use the UI instead 503 — SubscriberId is required 503 — ProviderId is required 503 — LocationId is required 503 — Proposal number length exceeds 30 symbols 503 — This proposal number already exists 503 — Project Description is required 503 — Project Description length exceeds 4000 symbols 503 — NotificationEmails is required 503 — Incorrect email(s) 503 — The limit for email addresses in a field is 50 503 — No proposal amount has been deposited 503 — Materials is required 503 — MaterialsAnswer is required 503 — MaterialsAnswer is not specified or incorrect 503 — Unit is not specified or incorrect 503 — CostsIncurredToDate is required 503 — CostsIncurredToDate has empty descriptions 503 — CostsIncurredToDate cannot be negative 503 — Total type is incorrect in CostsIncurredToDate 503 — InstallationLabor is required 503 — Invalid description in installationLabor 503 — NonInstallationExpensesOther has empty descriptions 503 — Total is required in NonInstallationExpensesOther 503 — OfTrips type is incorrect in Travel 503 — Currency type is incorrect 503 — Freight is required 503 — Freight decimal part exceeds two digits 503 — FreightOther is required 503 — Total is required in FreightOther 503 — FreightOther cannot be negative 503 — MaterialSalesTax cannot be negative 503 — InstallationLaborSalesTax cannot be negative 804 — User has no permissions to perform this action - `401`: The requested resource requires authentication.
Error codes: 504 — API call rejected by security permissions - `403`: You are not authorized to request this resource, or the resource is unavailable for some reason.
Error codes: 804 — The functionality is not enabled --- [API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)