POST api/service/create/campaign/quickstart/note

This endpoint has been sunsetted and is no longer supported. All requests will result in a 400 Bad Request response.

Request Information

Authentication Method

Partner Authentication
-Or-
Sub Partner Authentication

URI Parameters

None.

Body Parameters

QuickStart Job Note (Create)
NameDescriptionTypeAdditional information
jobId

The jobId provided when the service job was created.

string

Required if referenceId is not provided

referenceId

Valid JobId or ReferenceId is required

string

Required if jobId is not provided

note

Note about the job.

string

Required

Max length: 5000

Request Formats

application/json, text/json

Sample:
{
  "jobId": "aaaaaaaa-bbbb-cccc-dddd-111111111111",
  "referenceId": "XYZ1234",
  "note": "Work to be done"
}

application/xml, text/xml

Sample:
<QuickStartJobNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.CreateModels">
  <jobId>aaaaaaaa-bbbb-cccc-dddd-111111111111</jobId>
  <note>Work to be done</note>
  <referenceId>XYZ1234</referenceId>
</QuickStartJobNote>

Response Information

Successful Response:

Resource Description

QuickStart Job Note
NameDescriptionTypeAdditional information
id

string

 

jobId

string

 

Response Formats

application/json, text/json

Sample:
{
  "id": "22222222-3333-4444-5555-111111111111",
  "jobId": "aaaaaaaa-bbbb-cccc-dddd-111111111111"
}

application/xml, text/xml

Sample:
<QuickStartJobNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SiteWit.PartnerAPI.Models.ReturnModels">
  <id>22222222-3333-4444-5555-111111111111</id>
  <jobId>aaaaaaaa-bbbb-cccc-dddd-111111111111</jobId>
</QuickStartJobNote>