Add Potential

Parameters

Body Params
JSON:	json Potential details needs to be passed as body parameter,it should be in JSON format.
XML:	string Potential details needs to be passed as body parameter,it should be in XML format.

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": {
            "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>