POST Client/ScheduleRequestUpdate

Post ScheduleRequestUpdate

Request Information

URI Parameters

None.

Body Parameters

ParaSchedule

ParaSchedule
NameDescriptionTypeAdditional information
ScheduledRequestId

integer

None.

ScheduledBlockId

integer

None.

startUtcDate

date

None.

startUtcDateStr

string

None.

ScheduleDuration

integer

None.

PersonId

integer

None.

ClientName

string

None.

PIN

string

None.

ForceId

string

None.

PersonName

string

None.

PersonEmail

string

None.

PersonPhoneNumber

string

None.

ClientUserId

integer

None.

FromLanguageId

integer

None.

FromLanguage

string

None.

ToLanguageId

integer

None.

ToLanguage

string

None.

ProductName

string

None.

ProductDescription

string

None.

ProviderId

integer

None.

ProviderEmail

string

None.

ProviderPhoneNumber

string

None.

ProviderName

string

None.

ScheduleStatusDescription

string

None.

ScheduleStatusId

integer

None.

BillPersonPrechargeProductId

integer

None.

ScheduledRequestRoutingStatusCodeId

integer

None.

ScheduledRequestRoutingStatus

string

None.

JoinAvailable

boolean

None.

callPurpose

string

None.

ConfirmationNumber

string

None.

GenderOptionCode

string

None.

VideoOptionCode

string

None.

IsOffered

boolean

None.

ScheduledRequestProviderId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ScheduledRequestId": 1,
  "ScheduledBlockId": 1,
  "startUtcDate": "2025-04-25T15:05:01.001228Z",
  "startUtcDateStr": "sample string 1",
  "ScheduleDuration": 1,
  "PersonId": 1,
  "ClientName": "sample string 2",
  "PIN": "sample string 3",
  "ForceId": "sample string 4",
  "PersonName": "sample string 5",
  "PersonEmail": "sample string 6",
  "PersonPhoneNumber": "sample string 7",
  "ClientUserId": 1,
  "FromLanguageId": 1,
  "FromLanguage": "sample string 8",
  "ToLanguageId": 1,
  "ToLanguage": "sample string 9",
  "ProductName": "sample string 10",
  "ProductDescription": "sample string 11",
  "ProviderId": 1,
  "ProviderEmail": "sample string 12",
  "ProviderPhoneNumber": "sample string 13",
  "ProviderName": "sample string 14",
  "ScheduleStatusDescription": "sample string 15",
  "ScheduleStatusId": 1,
  "BillPersonPrechargeProductId": 1,
  "ScheduledRequestRoutingStatusCodeId": 1,
  "ScheduledRequestRoutingStatus": "sample string 16",
  "JoinAvailable": true,
  "callPurpose": "sample string 17",
  "ConfirmationNumber": "sample string 18",
  "GenderOptionCode": "sample string 19",
  "VideoOptionCode": "sample string 20",
  "IsOffered": true,
  "ScheduledRequestProviderId": 1
}

application/xml, text/xml

Sample:
<ParaSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <BillPersonPrechargeProductId>1</BillPersonPrechargeProductId>
  <ClientName>sample string 2</ClientName>
  <ClientUserId>1</ClientUserId>
  <ConfirmationNumber>sample string 18</ConfirmationNumber>
  <ForceId>sample string 4</ForceId>
  <FromLanguage>sample string 8</FromLanguage>
  <FromLanguageId>1</FromLanguageId>
  <GenderOptionCode>sample string 19</GenderOptionCode>
  <IsOffered>true</IsOffered>
  <JoinAvailable>true</JoinAvailable>
  <PIN>sample string 3</PIN>
  <PersonEmail>sample string 6</PersonEmail>
  <PersonId>1</PersonId>
  <PersonName>sample string 5</PersonName>
  <PersonPhoneNumber>sample string 7</PersonPhoneNumber>
  <ProductDescription>sample string 11</ProductDescription>
  <ProductName>sample string 10</ProductName>
  <ProviderEmail>sample string 12</ProviderEmail>
  <ProviderId>1</ProviderId>
  <ProviderName>sample string 14</ProviderName>
  <ProviderPhoneNumber>sample string 13</ProviderPhoneNumber>
  <ScheduleDuration>1</ScheduleDuration>
  <ScheduleStatusDescription>sample string 15</ScheduleStatusDescription>
  <ScheduleStatusId>1</ScheduleStatusId>
  <ScheduledBlockId>1</ScheduledBlockId>
  <ScheduledRequestId>1</ScheduledRequestId>
  <ScheduledRequestProviderId>1</ScheduledRequestProviderId>
  <ScheduledRequestRoutingStatus>sample string 16</ScheduledRequestRoutingStatus>
  <ScheduledRequestRoutingStatusCodeId>1</ScheduledRequestRoutingStatusCodeId>
  <ToLanguage>sample string 9</ToLanguage>
  <ToLanguageId>1</ToLanguageId>
  <VideoOptionCode>sample string 20</VideoOptionCode>
  <callPurpose>sample string 17</callPurpose>
  <startUtcDate>2025-04-25T15:05:01.001228Z</startUtcDate>
  <startUtcDateStr>sample string 1</startUtcDateStr>
</ParaSchedule>

Response Information

Resource Description

ParaSchedule

ParaSchedule
NameDescriptionTypeAdditional information
ScheduledRequestId

integer

None.

ScheduledBlockId

integer

None.

startUtcDate

date

None.

startUtcDateStr

string

None.

ScheduleDuration

integer

None.

PersonId

integer

None.

ClientName

string

None.

PIN

string

None.

ForceId

string

None.

PersonName

string

None.

PersonEmail

string

None.

PersonPhoneNumber

string

None.

ClientUserId

integer

None.

FromLanguageId

integer

None.

FromLanguage

string

None.

ToLanguageId

integer

None.

ToLanguage

string

None.

ProductName

string

None.

ProductDescription

string

None.

ProviderId

integer

None.

ProviderEmail

string

None.

ProviderPhoneNumber

string

None.

ProviderName

string

None.

ScheduleStatusDescription

string

None.

ScheduleStatusId

integer

None.

BillPersonPrechargeProductId

integer

None.

ScheduledRequestRoutingStatusCodeId

integer

None.

ScheduledRequestRoutingStatus

string

None.

JoinAvailable

boolean

None.

callPurpose

string

None.

ConfirmationNumber

string

None.

GenderOptionCode

string

None.

VideoOptionCode

string

None.

IsOffered

boolean

None.

ScheduledRequestProviderId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "ScheduledRequestId": 1,
  "ScheduledBlockId": 1,
  "startUtcDate": "2025-04-25T15:05:01.001228Z",
  "startUtcDateStr": "sample string 1",
  "ScheduleDuration": 1,
  "PersonId": 1,
  "ClientName": "sample string 2",
  "PIN": "sample string 3",
  "ForceId": "sample string 4",
  "PersonName": "sample string 5",
  "PersonEmail": "sample string 6",
  "PersonPhoneNumber": "sample string 7",
  "ClientUserId": 1,
  "FromLanguageId": 1,
  "FromLanguage": "sample string 8",
  "ToLanguageId": 1,
  "ToLanguage": "sample string 9",
  "ProductName": "sample string 10",
  "ProductDescription": "sample string 11",
  "ProviderId": 1,
  "ProviderEmail": "sample string 12",
  "ProviderPhoneNumber": "sample string 13",
  "ProviderName": "sample string 14",
  "ScheduleStatusDescription": "sample string 15",
  "ScheduleStatusId": 1,
  "BillPersonPrechargeProductId": 1,
  "ScheduledRequestRoutingStatusCodeId": 1,
  "ScheduledRequestRoutingStatus": "sample string 16",
  "JoinAvailable": true,
  "callPurpose": "sample string 17",
  "ConfirmationNumber": "sample string 18",
  "GenderOptionCode": "sample string 19",
  "VideoOptionCode": "sample string 20",
  "IsOffered": true,
  "ScheduledRequestProviderId": 1
}

application/xml, text/xml

Sample:
<ParaSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <BillPersonPrechargeProductId>1</BillPersonPrechargeProductId>
  <ClientName>sample string 2</ClientName>
  <ClientUserId>1</ClientUserId>
  <ConfirmationNumber>sample string 18</ConfirmationNumber>
  <ForceId>sample string 4</ForceId>
  <FromLanguage>sample string 8</FromLanguage>
  <FromLanguageId>1</FromLanguageId>
  <GenderOptionCode>sample string 19</GenderOptionCode>
  <IsOffered>true</IsOffered>
  <JoinAvailable>true</JoinAvailable>
  <PIN>sample string 3</PIN>
  <PersonEmail>sample string 6</PersonEmail>
  <PersonId>1</PersonId>
  <PersonName>sample string 5</PersonName>
  <PersonPhoneNumber>sample string 7</PersonPhoneNumber>
  <ProductDescription>sample string 11</ProductDescription>
  <ProductName>sample string 10</ProductName>
  <ProviderEmail>sample string 12</ProviderEmail>
  <ProviderId>1</ProviderId>
  <ProviderName>sample string 14</ProviderName>
  <ProviderPhoneNumber>sample string 13</ProviderPhoneNumber>
  <ScheduleDuration>1</ScheduleDuration>
  <ScheduleStatusDescription>sample string 15</ScheduleStatusDescription>
  <ScheduleStatusId>1</ScheduleStatusId>
  <ScheduledBlockId>1</ScheduledBlockId>
  <ScheduledRequestId>1</ScheduledRequestId>
  <ScheduledRequestProviderId>1</ScheduledRequestProviderId>
  <ScheduledRequestRoutingStatus>sample string 16</ScheduledRequestRoutingStatus>
  <ScheduledRequestRoutingStatusCodeId>1</ScheduledRequestRoutingStatusCodeId>
  <ToLanguage>sample string 9</ToLanguage>
  <ToLanguageId>1</ToLanguageId>
  <VideoOptionCode>sample string 20</VideoOptionCode>
  <callPurpose>sample string 17</callPurpose>
  <startUtcDate>2025-04-25T15:05:01.001228Z</startUtcDate>
  <startUtcDateStr>sample string 1</startUtcDateStr>
</ParaSchedule>