Top
Top
  1. Workamajig
  2. IT Info
  3. API Info

Articles in this section

API: Opportunities

Methods

Retrieve an opportunity

GET /opportunities?opportunityKey=YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090
URL Parameters
opportunityKey: required <unique identifier for the activity
Example Request
https://workamajig.com/api/beta1/opportunities?opportunityKey=YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090
Example Response
{
    "logid": "f1dec48c-a043-4212-a0b4-00300950ad8c",
    "data": {
        "opportunity": {
            "contactName": null,
            "agi": null,
            "mediaGross": "",
            "outsideCostsGross": null,
            "accountManagerKey": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "bidDate": null,
            "dateUpdated": "2009-01-14T21:40:00",
            "companyKey": "SnRwMWdBSjRPQU9HZlcwa1VqaStaUT090",
            "modifiedByName": "Greg O'Geiger",
            "leadStageName": "Initial Contact",
            "leadStatusName": "Open",
            "email": null,
            "accountManagerName": "Greg O'Geiger",
            "subject": "Marketing Campaign",
            "saleAmount": "aHZ6U0N2eTdFNW9TVnVBcXFvaGl3Zz090",
            "multipleSegments": null,
            "leadStatusKey": "ck9QOW9COEtDeWdrTHRwajVKTlhNQT090",
            "lastActivitySubject": null,
            "startDate": null,
            "probability": null,
            "estimateType": null,
            "lastActivityKey": "",
            "updatedByKey": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "lastActivityDate": "",
            "phone1": null,
            "companyName": "Pepsi Cola Inc.",
            "contactKey": "",
            "contactCompanyKey": "VzBaTUpYS09XaWo0ZEFjQzNUTUdRQT090",
            "outsideCostsPerc": null,
            "mediaPerc": null,
            "comments": null,
            "leadStageKey": "bkwwMGNTTmJhSUdPUGtOaDJlL2s3Zz090",
            "dateAdded": "DateAdded",
            "opportunityKey": "aFpzOFRmeUozU3FJckNMTm5MR05iUT090"
        }
    }
}
 

Create a new opportunity

POST /opportunities
Parameters
subject: required
linkedCompanyKey: required
contactKey: optional
contactName: optional
accountManagerKey: optional
projectTypeKey: optional
competitors: optional
currentStatus: optional
outcomeComment: optional
probability: optional
saleAmount: optional
outsideCostsGross: optional
mediaGross: optional
outsideCostsGross: optional
mediaGross: optional
outsideCostsPercentage: optional
mediaPercentage: optional
agi: optional
subAmount: optional
margin: optional
bid: optional
bidDate: optional
activityDate: required
startDate: optional
estCloseDate: optional
actualCostDate: optional
dateConverted: optional
estimateType: optional
labor: optional
months: optional
leadStatusName: required if leadStatusKey is blank
leadStatusKey: required if leadStatusName is blank
leadStageName: required if leadStageKey is blank
leadStageKey: required if leadStageName is blank

 

Example Request
https://workamajig.com/api/beta1/opportunities
[
 {
     "subject":"Initial point of contact",
     "linkedCompanyKey":"ZUZFVG11NmU5blM1eHhnRnIyay9sUT090",
     "competitors":"Advantage, Base Camp",
     "probability":"50",
     "saleAmount":"250000",   
     "leadStatusName":"Open",
     "leadStageName":"Initial Contact"
 }
]
Example Response
{
  "success": [
    {
      "opportunityKey": "bEZScHJIK1puaUI2OHl0dFVYbTNOQT090",
      "data": {
        "currentStatus": "",
        "activityDate": "",
        "estCloseDate": "",
        "bid": "",
        "subject": "API Opportunity 1",
        "startDate": "",
        "leadStatusName": "Open",
        "agi": "",
        "estimateType": "",
        "probability": "50",
        "outsideCostPercentage": "",
        "competitors": "Advantage, Base Camp",
        "actualCloseDate": "",
        "leadStageName": "Initial Contact",
        "linkedCompanyKey": "ZUZFVG11NmU5blM1eHhnRnIyay9sUT090",
        "mediaGross": "",
        "subAmount": "",
        "dateConverted": "",
        "saleAmount": "250000",
        "mediaPercentage": "",
        "bidDate": "",
        "outsideCostsGross": "",
        "leadStatusKey": "",
        "margin": "",
        "leadStatgeKey": "",
        "comments": "",
        "labor": ""
      }
    }
  ],
  "logid": "9de63cf2-d606-4cc0-8a36-02fed2c8e80e"
}

 

Update an opportunity

PUT /opportunities/{id}
Parameters
subject: required
linkedCompanyKey: required
contactKey: optional
contactName: optional
accountManagerKey: optional
projectTypeKey: optional
competitors: optional
currentStatus: optional
outcomeComment: optional
probability: optional
saleAmount: optional
outsideCostsGross: optional
mediaGross: optional
outsideCostsGross: optional
mediaGross: optional
outsideCostsPercentage: optional
mediaPercentage: optional
agi: optional
subAmount: optional
margin: optional
bid: optional
bidDate: optional
activityDate: required
startDate: optional
estCloseDate: optional
actualCostDate: optional
dateConverted: optional
estimateType: optional
labor: optional
months: optional
leadStatusName: required if leadStatusKey is blank
leadStatusKey: required if leadStatusName is blank
leadStageName: required if leadStageKey is blank
leadStageKey: required if leadStageName is blank
 

 

Example Request
https://workamajig.com/api/beta1/opportunities
[
 {
     "opportunityKey": "MUhuc1hlWTRWYW80eWd5ZmhiNEM4dz090",
     "subject":"API Opportunity 1-a",
     "linkedCompanyKey":"Sy9VQVdmSlppZnFBYTdnbnQzcGM4dz090",
     "competitors":"Advantage, Base Camp",
     "currentStatus":"",
     "probability":"50",
     "saleAmount":"250000",
     "leadStatusName":"Open",
     "leadStageName":"Initial Contact"
 }
]
Example Response
{
  "success": [
    {
      "opportunityKey": "MUhuc1hlWTRWYW80eWd5ZmhiNEM4dz090"
    }
  ],
  "logid": "1f896063-97bd-4bfc-a527-81121fa32350"
}

 

Delete an opportunity

DELETE /opportunities/{id}
Parameters
opportunityKey: required <unique identifier for the opportunity>

 

Example Request
https://workamajig.com/api/beta1/opportunities
[
 { "opportunityKey":"TzE4eU56VUJnTG03WWJtNVJmWFd0Zz090" },
 { "opportunityKey":"UkNHY1o0U0hPUmFhb2c2WVJJMXpRUT090" },
]
Example Response
{
  "success": [
    {
      "opportunityKey": "TzE4eU56VUJnTG03WWJtNVJmWFd0Zz090"     
    },
    {
      "opportunityKey": "UkNHY1o0U0hPUmFhb2c2WVJJMXpRUT090"
    }
  ],
  "logid": "5eda3503-80db-438d-b164-f8266ecae29c"
}

Related articles