POST leads/update

Update lead information

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LeadId	integer	None.
LeadSource	string	None.
Status	integer	None.
Classification	integer	None.
OwnerUserID	integer	None.
OwnerName	string	None.
Note	string	None.
Groups	Collection of string	None.
Tags	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "LeadId": 1,
  "LeadSource": "sample string 2",
  "Status": 1,
  "Classification": 1,
  "OwnerUserID": 1,
  "OwnerName": "sample string 3",
  "Note": "sample string 4",
  "Groups": [
    "sample string 1",
    "sample string 2"
  ],
  "Tags": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<UpdateLeadApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.Lead">
  <Classification>1</Classification>
  <Groups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Groups>
  <LeadId>1</LeadId>
  <LeadSource>sample string 2</LeadSource>
  <Note>sample string 4</Note>
  <OwnerName>sample string 3</OwnerName>
  <OwnerUserID>1</OwnerUserID>
  <Status>1</Status>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tags>
</UpdateLeadApiModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateLeadApiModel'.

Response Information

Resource Description

UpdateLeadOutput

Name	Description	Type	Additional information
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<UpdateLeadOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.Lead">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
</UpdateLeadOutput>