---
title: "Creates a work request"
method: POST
path: "/workrequests"
tags: ["WorkRequests"]
---

# Creates a work request

`POST /workrequests`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/workrequests`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/workrequests/post.ts> (a function with typed inputs; its response is checked against the schema)

*In limited availability phase.*

## Request body

- ServiceChannelServicesMessagingWorkRequestsCreateWorkRequestRequest: Request to create a work request
  - `SubscriberId` integer: Subscriber Id
  - `ProviderId` integer: Provider Id
  - `EventId` string: Optional. Guid of IoT event. For example, B216E711-420F-4D32-9080-762CBFD4E732
  - `LocationId` integer: Location Id
  - `StatusId` integer: WorkRequest status Id
  - `ExtendedStatusId` integer: WorkRequest extended status Id
  - `Description` string: Description. Free text.
  - `TradeId` integer: Trade Id
  - `CategoryId` integer: Catgory Id
  - `PriorityId` integer: Priority Id
  - `Caller` string: Optional. Caller
  - `CallDate` string: Call date. In UTC
  - `ScheduledDate` string: Optional. Scheduled date. In UTC
  - `AssetId` integer: Optional. Asset Id
  - `Nte` ServiceChannelServicesMessagingWorkRequestsCreateWorkRequestNteRequest: Request to set NTE for a work request
    - `Value` number, double: Value
    - `CurrencyId` integer: Currency Id
  - `Issue` ServiceChannelServicesMessagingWorkRequestsCreateWorkRequestIssueRequest: Request to set issue parameters for a work request
    - `AreaId` integer: Area Id
    - `ProblemType` string: Problem type
    - `Equipment` string: Equipment
    - `ProblemCode` string: Problem code
    - `SetupId` integer: Setup(dashboard) Id
  - `Attachments` ServiceChannelServicesMessagingWorkRequestsCreateWorkRequestAttachmentRequest[]: Optional. Attachments
    - `Description` string: Description
    - `FileName` string: File name of a uploaded attachment. For example, #workorders/0DD13443-EAF4-4A1D-930B-992EFC8ED3E0
    - `OriginalName` string: Original file name. For example, my-file.pdf
    - `Visibility` integer: Visibility

## Response `201`

Created indicates that the request resulted in a new resource created before the response was sent.

- ServiceChannelServicesMessagingWorkRequestsCreateWorkRequestResponse: Response for work request creation
  - `Id` integer: Id of the created work request

## Other responses

- `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 101 - Invalid provider id 301 - Contract not found for specified subscribers location, provider and trade 401 - Invalid subscriber 601 - Location is not found 701 - Invalid trade 8001 — Description is required 8002 — Call Date is required 8003 — Issue is required 8005 - CallDate has wrong format 8006 - ScheduledDate has wrong format 8007 - Invalid status 8008 - Invalid extended status 8009 - Invalid category 8010 - Invalid priority 8011 - Invalid currency 8012 - Invalid setup 8013 - Invalid area 8014 - Invalid asset 8017 - ProblemCode is required 8018 - ProblemType is required 8019 - ScheduledDate must be greater than CallDate
- `401`: The request is not authorized. <br/>Error codes: 504 — API call rejected by security permissions
- `500`: Indicates that a generic error has occurred on the server. <br/>Error codes: 501 - Internal Error code

---

[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)