API ReferenceGuides
Guides
Home
Start typing to search…

Update Potential

Use this operation to update any of the writable fields of an existing Potential object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.

Parameters

Body Params

JSON:

json
Potential details needs to be passed as body parameter,it should be in JSON format.Unique parameter need to be passed in JSON for eg. Potential Id/Potential Subject.

XML:

string
Potential details needs to be passed as body parameter,it should be in XML format.Unique parameter need to be passed in XML for eg. Potential Id/Potential Subject.

Path Params

yourCompany:

string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Potential will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Potential

Header Params

Accept:

string
Response header need to be passed for eg. application/json or application/xml.

Query Auth

key:

string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth

apiKey:

string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Code

{
    "Potentials": {
        "Potential": {
            "PotentialId": "140605",
            "PotentialName": "Potential No1",
            "Amount": "10.000",
            "AccountName": "Retail Sale1234",
            "ExpectedCloseDate": "09-10-2026",
            "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": "23-10-2024 13:41:52",
            "ModifiedTimeUTC": "23-10-2024 08:11:52",
            "Description": "Description goes here",
            "PotentialCustomFields": {
                "CustomField": [
                    {
                        "Name": "Text",
                        "Value": "Customfield Text"
                    },
                    {
                        "Name": "Pick List",
                        "Value": "A"
                    },
                    {
                        "Name": "CheckBox",
                        "Value": "0"
                    },
                    {
                        "Name": "Date",
                        "Value": "00-00-0000"
                    }
                ]
            }
        }
    }
}
<Potentials>
    <Potential>
        <PotentialId>140605</PotentialId>
        <PotentialName>Potential No1</PotentialName>
        <Amount>10.000</Amount>
        <AccountName>Retail Sale1234</AccountName>
        <ExpectedCloseDate>09-10-2026</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>23-10-2024 13:41:52</ModifiedTime>
        <ModifiedTimeUTC>23-10-2024 08:11:52</ModifiedTimeUTC>
        <Description>Description goes here</Description>
        <PotentialCustomFields>
            <CustomField>
                <Name>Text</Name>
                <Value>Customfield Text</Value>
            </CustomField>
            <CustomField>
                <Name>Pick List</Name>
                <Value>A</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 04:13:46"
        },
        "parameters": {
            "results": {
                "message": {
                    "status": "Success",
                    "success_message": {
                        "potential_name": "Potential No1",
                        "potential_id": "140606"
                    }
                }
            }
        }
    }
}
<MCM>
    <response>
        <objectType>Potential</objectType>
        <syncTime>2024-10-23 04:13:46</syncTime>
    </response>
    <parameters>
        <results>
            <message>
                <status>Success</status>
                <success_message>
                    <potential_name>Potential No1</potential_name>
                    <potential_id>140606</potential_id>
                </success_message>
            </message>
        </results>
    </parameters>
</MCM>

WADL

<?xml version="1.0" encoding="UTF-8"?>
<application>
	<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
		<resource path="Potential">
			<method name="PUT">
				<request>
					<param name="key" type="xsd:string" style="query" required="true" />
          <param name="PotentialId" type="xsd:int" style="body" 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

© Copyright 2022 Agiliron - All Rights Reserved.