POST api/ApiIntegration/SBApiUpdateProject
Request Information
URI Parameters
None.
Body Parameters
ApiProjectParam| Name | Description | Type | Additional information |
|---|---|---|---|
| PrivateApiKey | string |
None. |
|
| Project | ApiProjectInfo |
None. |
|
| Client | ApiClientInfo |
None. |
Request Formats
application/json, text/json
Sample:
{
"privateApiKey": "sample string 1",
"project": {
"projectKey": "9891ee01-36a0-4eb2-979f-3e52dcccf079",
"projectName": "sample string 2",
"jobName": "sample string 3",
"jobNote1": "sample string 4",
"jobNote2": "sample string 5",
"salesPerson": "sample string 6",
"jobDate": "2026-06-19T00:29:26.3581467+00:00",
"quoteNumber": "sample string 7",
"jobNumber": "sample string 8",
"po": "sample string 9"
},
"client": {
"apiResponse": {
"responseCode": 1,
"returnKey": "1490c356-2202-476e-9d34-3ec6b63fafb5",
"responseNote": "sample string 2"
},
"clientKey": "c1160fb1-8e60-4ca5-9eeb-d8bfe44fc857",
"clientName": "sample string 2",
"clientNote": "sample string 3",
"contactName": "sample string 4",
"salutation": "sample string 5",
"noAndStreet": "sample string 6",
"suburb": "sample string 7",
"city": "sample string 8",
"phone": "sample string 9",
"mobile": "sample string 10",
"email": "sample string 11",
"criticalNote": "sample string 12",
"showCritical": true,
"isOwner": true,
"pay1Percent": 15,
"pay2Percent": 16,
"pay2Days": 17,
"terms2": 18,
"pay3Days": 19,
"terms3": 20,
"discount": 21
}
}
application/xml, text/xml
Sample:
<ApiProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<Client>
<ApiResponse>
<ResponseCode>1</ResponseCode>
<ResponseNote>sample string 2</ResponseNote>
<ReturnKey>1490c356-2202-476e-9d34-3ec6b63fafb5</ReturnKey>
</ApiResponse>
<City>sample string 8</City>
<ClientKey>c1160fb1-8e60-4ca5-9eeb-d8bfe44fc857</ClientKey>
<ClientName>sample string 2</ClientName>
<ClientNote>sample string 3</ClientNote>
<ContactName>sample string 4</ContactName>
<CriticalNote>sample string 12</CriticalNote>
<Discount>21</Discount>
<Email>sample string 11</Email>
<IsOwner>true</IsOwner>
<Mobile>sample string 10</Mobile>
<NoAndStreet>sample string 6</NoAndStreet>
<Pay1Percent>15</Pay1Percent>
<Pay2Days>17</Pay2Days>
<Pay2Percent>16</Pay2Percent>
<Pay3Days>19</Pay3Days>
<Phone>sample string 9</Phone>
<Salutation>sample string 5</Salutation>
<ShowCritical>true</ShowCritical>
<Suburb>sample string 7</Suburb>
<Terms2>18</Terms2>
<Terms3>20</Terms3>
</Client>
<PrivateApiKey>sample string 1</PrivateApiKey>
<Project>
<JobDate>2026-06-19T00:29:26.3581467+00:00</JobDate>
<JobName>sample string 3</JobName>
<JobNote1>sample string 4</JobNote1>
<JobNote2>sample string 5</JobNote2>
<JobNumber>sample string 8</JobNumber>
<PO>sample string 9</PO>
<ProjectKey>9891ee01-36a0-4eb2-979f-3e52dcccf079</ProjectKey>
<ProjectName>sample string 2</ProjectName>
<QuoteNumber>sample string 7</QuoteNumber>
<SalesPerson>sample string 6</SalesPerson>
</Project>
</ApiProjectParam>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ApiResponse | ApiResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"apiResponse": {
"responseCode": 1,
"returnKey": "79381573-941b-41dd-a0ec-3ac4993064cd",
"responseNote": "sample string 2"
}
}
application/xml, text/xml
Sample:
<ApiResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<ApiResponse>
<ResponseCode>1</ResponseCode>
<ResponseNote>sample string 2</ResponseNote>
<ReturnKey>79381573-941b-41dd-a0ec-3ac4993064cd</ReturnKey>
</ApiResponse>
</ApiResponseModel>