POST api/ApiIntegration/SBApiUpsertJob

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
ProjectKey	globally unique identifier	None.
JobInfo	ApiUpsertJobInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "projectKey": "5fe926ce-a13e-4e29-86ca-d7d9e559aed2",
  "jobInfo": {
    "jobKey": "e44c9730-e227-4b68-bbe1-5110fe7e7d95",
    "jobName": "sample string 2",
    "scenarioName": "sample string 3",
    "jobNote": "sample string 4",
    "quoteNumber": "sample string 5",
    "jobNumber": "sample string 6",
    "jobDate": "2026-11-03T18:22:23.5839206+00:00",
    "purchaseOrder": "sample string 7",
    "salesPerson": "sample string 8"
  }
}

application/xml, text/xml

Sample:

<ApiUpsertJobParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <JobInfo>
    <JobDate>2026-11-03T18:22:23.5839206+00:00</JobDate>
    <JobKey>e44c9730-e227-4b68-bbe1-5110fe7e7d95</JobKey>
    <JobName>sample string 2</JobName>
    <JobNote>sample string 4</JobNote>
    <JobNumber>sample string 6</JobNumber>
    <PurchaseOrder>sample string 7</PurchaseOrder>
    <QuoteNumber>sample string 5</QuoteNumber>
    <SalesPerson>sample string 8</SalesPerson>
    <ScenarioName>sample string 3</ScenarioName>
  </JobInfo>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <ProjectKey>5fe926ce-a13e-4e29-86ca-d7d9e559aed2</ProjectKey>
</ApiUpsertJobParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse

Name	Type	Additional information
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.
ErrorString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "21dd048a-ba7a-4212-be45-d0823b5a1c7b",
  "responseNote": "sample string 2",
  "errorString": "sample string 3"
}

application/xml, text/xml

Sample:

<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ErrorString>sample string 3</ErrorString>
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>21dd048a-ba7a-4212-be45-d0823b5a1c7b</ReturnKey>
</ApiResponse>