POST v1/Clients/{clientId}/ServiceChannelWorkOrders?accessKey={accessKey}&signingKey={signingKey}

Updates a ServiceChannel work order's associated activity, if there is one. The access key and signing key must be provided via the query string.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Client identifier.

 globally unique identifier

Required
accessKey

The access key provided by the webhook.

 string

Required
signingKey

The signing key provided by the webhook.

 string

Required

Body Parameters

The ServiceChannel Work Order provided.

ServiceChannelWorkOrderEventResponseV1
NameDescriptionTypeAdditional information
Object

The ServiceChannel Work Order details.

 ServiceChannelWorkOrderV1

None.
Type

The type of notification.

 string

None.
Action

The action being performed.

 string

None.
EventType

Tells the event type that occurred to the Work Order.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Object": {
    "Id": 1,
    "Number": "sample string 2",
    "PurchaseNumber": "sample string 3",
    "SubscriberId": 4,
    "ProviderId": 5,
    "LocationId": 6,
    "Status": {
      "Primary": "sample string 1",
      "Extended": "sample string 2"
    },
    "Caller": "sample string 7",
    "CreatedBy": "sample string 8",
    "CallDate": "2025-12-19T15:01:54.4393284+00:00",
    "ReassignDate": "2025-12-19T15:01:54.4393284+00:00",
    "Priority": "sample string 10",
    "Trade": "sample string 11",
    "ScheduledDate": "2025-12-19T15:01:54.4393284+00:00",
    "CompletedDate": "2025-12-19T15:01:54.4393284+00:00",
    "ExpirationDate": "2025-12-19T15:01:54.4393284+00:00",
    "Description": "sample string 13",
    "Category": "sample string 14",
    "Nte": 1.0,
    "CurrencyAlphabeticalCode": "sample string 15",
    "ProblemCode": "sample string 16",
    "Resolution": "sample string 17",
    "AssetId": 1,
    "Source": "sample string 18",
    "RecallWorkOrder": 1,
    "Notes": [
      {
        "Id": 1,
        "Number": 2,
        "NoteData": "sample string 3",
        "DateCreated": "2025-12-19T15:01:54.4393284+00:00",
        "ScheduledDate": "2025-12-19T15:01:54.4393284+00:00",
        "FollowUpDate": "2025-12-19T15:01:54.4393284+00:00",
        "ActionRequired": true,
        "MailedTo": "sample string 6",
        "CreatedBy": "sample string 7"
      },
      {
        "Id": 1,
        "Number": 2,
        "NoteData": "sample string 3",
        "DateCreated": "2025-12-19T15:01:54.4393284+00:00",
        "ScheduledDate": "2025-12-19T15:01:54.4393284+00:00",
        "FollowUpDate": "2025-12-19T15:01:54.4393284+00:00",
        "ActionRequired": true,
        "MailedTo": "sample string 6",
        "CreatedBy": "sample string 7"
      }
    ]
  },
  "Type": "sample string 1",
  "Action": "sample string 2",
  "EventType": "sample string 3"
}

application/xml, text/xml

Sample: 
<ServiceChannelWorkOrderEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models.ServiceChannel">
  <Action>sample string 2</Action>
  <EventType>sample string 3</EventType>
  <Object>
    <AssetId>1</AssetId>
    <CallDate>2025-12-19T15:01:54.4393284+00:00</CallDate>
    <Caller>sample string 7</Caller>
    <Category>sample string 14</Category>
    <CompletedDate>2025-12-19T15:01:54.4393284+00:00</CompletedDate>
    <CreatedBy>sample string 8</CreatedBy>
    <CurrencyAlphabeticalCode>sample string 15</CurrencyAlphabeticalCode>
    <Description>sample string 13</Description>
    <ExpirationDate>2025-12-19T15:01:54.4393284+00:00</ExpirationDate>
    <Id>1</Id>
    <LocationId>6</LocationId>
    <Notes>
      <ServiceChannelWorkOrderNote>
        <ActionRequired>true</ActionRequired>
        <CreatedBy>sample string 7</CreatedBy>
        <DateCreated>2025-12-19T15:01:54.4393284+00:00</DateCreated>
        <FollowUpDate>2025-12-19T15:01:54.4393284+00:00</FollowUpDate>
        <Id>1</Id>
        <MailedTo>sample string 6</MailedTo>
        <NoteData>sample string 3</NoteData>
        <Number>2</Number>
        <ScheduledDate>2025-12-19T15:01:54.4393284+00:00</ScheduledDate>
      </ServiceChannelWorkOrderNote>
      <ServiceChannelWorkOrderNote>
        <ActionRequired>true</ActionRequired>
        <CreatedBy>sample string 7</CreatedBy>
        <DateCreated>2025-12-19T15:01:54.4393284+00:00</DateCreated>
        <FollowUpDate>2025-12-19T15:01:54.4393284+00:00</FollowUpDate>
        <Id>1</Id>
        <MailedTo>sample string 6</MailedTo>
        <NoteData>sample string 3</NoteData>
        <Number>2</Number>
        <ScheduledDate>2025-12-19T15:01:54.4393284+00:00</ScheduledDate>
      </ServiceChannelWorkOrderNote>
    </Notes>
    <Nte>1</Nte>
    <Number>sample string 2</Number>
    <Priority>sample string 10</Priority>
    <ProblemCode>sample string 16</ProblemCode>
    <ProviderId>5</ProviderId>
    <PurchaseNumber>sample string 3</PurchaseNumber>
    <ReassignDate>2025-12-19T15:01:54.4393284+00:00</ReassignDate>
    <RecallWorkOrder>1</RecallWorkOrder>
    <Resolution>sample string 17</Resolution>
    <ScheduledDate>2025-12-19T15:01:54.4393284+00:00</ScheduledDate>
    <Source>sample string 18</Source>
    <Status>
      <Extended>sample string 2</Extended>
      <Primary>sample string 1</Primary>
    </Status>
    <SubscriberId>4</SubscriberId>
    <Trade>sample string 11</Trade>
  </Object>
  <Type>sample string 1</Type>
</ServiceChannelWorkOrderEventResponse>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The id of the activity updated, if there was one.

integer

Response Formats

application/json, text/json

Sample: 
1

application/xml, text/xml

Sample: 
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>