Add Potential
Use this operation to add new Potential object.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Potentials": {
"Potential": {
"PotentialName": "Potential",
"Amount": "10.000",
"AccountName": "John Doe",
"ExpectedCloseDate": "07-10-2021",
"Type": "--None--",
"NextStep": "Call before 15 days",
"LeadSource": "--None--",
"SalesStage": "Proposal/Price Quote",
"AssignedTo": "admin",
"Probability": "0.000",
"CreatedTime": "07-10-2021 20:38:10",
"CreatedTimeUTC": "07-10-2021 15:08:10",
"ModifiedTime": "07-10-2021 20:38:10",
"ModifiedTimeUTC": "07-10-2021 15:08:10",
"Description": "Description goes here",
"PotentialCustomFields": {
"CustomField": [
{
"Name": "Text",
"Value": "Customfield Text"
},
{
"Name": "CheckBox",
"Value": "0"
},
{
"Name": "Date",
"Value": "00-00-0000"
}
]
}
}
}
}
<Potentials>
<Potential>
<PotentialName>Potential</PotentialName>
<Amount>10.000</Amount>
<AccountName>John Doe</AccountName>
<ExpectedCloseDate>07-10-2021</ExpectedCloseDate>
<Type>--None--</Type>
<NextStep>Call before 15 days</NextStep>
<LeadSource>--None--</LeadSource>
<SalesStage>Proposal/Price Quote</SalesStage>
<AssignedTo>admin</AssignedTo>
<Probability>0.000</Probability>
<CreatedTime>07-10-2021 20:38:10</CreatedTime>
<CreatedTimeUTC>07-10-2021 15:08:10</CreatedTimeUTC>
<ModifiedTime>07-10-2021 20:38:10</ModifiedTime>
<ModifiedTimeUTC>07-10-2021 15:08:10</ModifiedTimeUTC>
<Description>Description goes here</Description>
<PotentialCustomFields>
<CustomField>
<Name>Text</Name>
<Value>Customfield Text</Value>
</CustomField>
<CustomField>
<Name>CheckBox</Name>
<Value>0</Value>
</CustomField>
<CustomField>
<Name>Date</Name>
<Value>00-00-0000</Value>
</CustomField>
</PotentialCustomFields>
</Potential>
</Potentials>
Sample Response
{
"MCM": {
"response": {
"objectType": "Potential",
"syncTime": "2024-10-23 03:51:19"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"potential_name": "Potential No1",
"potential_id": "140605"
}
}
}
}
}
}
<MCM>
<response>
<objectType>Potential</objectType>
<syncTime>2024-10-23 03:51:19</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<potential_name>Potential No1</potential_name>
<potential_id>140605</potential_id>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Potential">
<method name="POST">
<request>
<param name="key" type="xsd:string" style="query" required="true" />
<param name="PotentialName" type="xsd:String" style="body" required="true" />
<param name="Amount" type="xsd:int" style="body" />
<param name="AccountName" type="xsd:String" style="body" />
<param name="ExpectedCloseDate" type="xsd:dateTime" style="body" required="true" />
<param name="Type" type="xsd:String" style="body" />
<param name="NextStep" type="xsd:String" style="body" />
<param name="LeadSource" type="xsd:String" style="body" />
<param name="SalesStage" type="xsd:String" style="body" />
<param name="Probability" type="xsd:int" style="body" />
<param name="AssignedTo" type="xsd:string" style="body" />
<param name="CreatedTime" type="xsd:dateTime" style="body" />
<param name="ModifiedTime" type="xsd:dateTime" style="body" />
<param name="Description" type="xsd:string" style="body" />
<NotesId>36189</NotesId>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet" />
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error" />
</response>
</method>
</resource>
</resources>
</application>
Updated about 21 hours ago