{ "opencollection": "1.0.0", "info": { "name": "Act! Web API — Opportunities", "version": "v1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Opportunities", "type": "folder" }, "items": [ { "info": { "name": "Associate an opportunity to a specific company.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/companies/:companyId/associated-opportunities/:opportunityId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier (id) for a given company." }, { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Associate an opportunity to a specific company." }, { "info": { "name": "Dissociate an opportunity from a specific company.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/companies/:companyId/associated-opportunities/:opportunityId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier (id) for a given company." }, { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Dissociate an opportunity from a specific company." }, { "info": { "name": "List of opportunities from a specific company and matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/companies/:companyId/associated-opportunities", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier (id) for a given company." } ] }, "docs": "List of opportunities from a specific company and matching an (optional) OData query." }, { "info": { "name": "Associate a list of opportunities to a specific company.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/companies/:companyId/associated-opportunities", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier (id) for a given company." }, { "name": "phoneFormat", "value": "", "type": "query", "description": "Phone formats: None: APC Local Format, E164: Internation Format" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a list of opportunities to a specific company." }, { "info": { "name": "Dissociate a list of opportunities from a specific company.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/companies/:companyId/associated-opportunities", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The unique identifier (id) for a given company." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Dissociate a list of opportunities from a specific company." }, { "info": { "name": "Associate an opportunity to a specific contact.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/contacts/:contactId/associated-opportunities/:opportunityId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The unique identifier (id) for a given contact." }, { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Associate an opportunity to a specific contact." }, { "info": { "name": "Dissociate an opportunity from a specific contact.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/contacts/:contactId/associated-opportunities/:opportunityId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The unique identifier (id) for a given contact." }, { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Dissociate an opportunity from a specific contact." }, { "info": { "name": "List of opportunities from a specific contact and matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/contacts/:contactId/associated-opportunities", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The unique identifier (id) for a given contact." } ] }, "docs": "List of opportunities from a specific contact and matching an (optional) OData query." }, { "info": { "name": "Associate a list of opportunities to a specific contact.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/contacts/:contactId/associated-opportunities", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The unique identifier (id) for a given contact." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a list of opportunities to a specific contact." }, { "info": { "name": "Dissociate a list of opportunities from a specific contact.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/contacts/:contactId/associated-opportunities", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The unique identifier (id) for a given contact." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Dissociate a list of opportunities from a specific contact." }, { "info": { "name": "Associate an opportunity to a specific group.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/groups/:groupId/associated-opportunities/:opportunityId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier (id) for a given group." }, { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Associate an opportunity to a specific group." }, { "info": { "name": "Dissociate an opportunity from a specific group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/groups/:groupId/associated-opportunities/:opportunityId", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier (id) for a given group." }, { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Dissociate an opportunity from a specific group." }, { "info": { "name": "List of opportunities from a specific group and matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/groups/:groupId/associated-opportunities", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier (id) for a given group." } ] }, "docs": "List of opportunities from a specific group and matching an (optional) OData query." }, { "info": { "name": "Associate a list of opportunities to a specific group.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/groups/:groupId/associated-opportunities", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier (id) for a given group." }, { "name": "phoneFormat", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a list of opportunities to a specific group." }, { "info": { "name": "Dissociate a list of opportunities from a specific group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/groups/:groupId/associated-opportunities", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "The unique identifier (id) for a given group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Dissociate a list of opportunities from a specific group." }, { "info": { "name": "Get a specific opportunity.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Get a specific opportunity." }, { "info": { "name": "Update an already existing opportunity.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an already existing opportunity." }, { "info": { "name": "Partially update an already existing opportunity.", "type": "http" }, "http": { "method": "PATCH", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update an already existing opportunity." }, { "info": { "name": "Delete a specific opportunity.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Delete a specific opportunity." }, { "info": { "name": "Get a opportunity process.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/processes/:processId", "params": [ { "name": "processId", "value": "", "type": "path", "description": "The unique identifier (id) for a given process." } ] }, "docs": "Get a opportunity process." }, { "info": { "name": "Update an already existing process.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/opportunities/processes/:processId", "params": [ { "name": "processId", "value": "", "type": "path", "description": "The unique identifier (id) for a given process." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an already existing process." }, { "info": { "name": "Partially update an already existing process.", "type": "http" }, "http": { "method": "PATCH", "url": "https://apimta.act.com/act.web.api/api/opportunities/processes/:processId", "params": [ { "name": "processId", "value": "", "type": "path", "description": "The unique identifier (id) for a given process." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update an already existing process." }, { "info": { "name": "Delete a specific opportunity process.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/opportunities/processes/:processId", "params": [ { "name": "processId", "value": "", "type": "path", "description": "The unique identifier (id) for a given process." } ] }, "docs": "Delete a specific opportunity process." }, { "info": { "name": "Get all product(s) that are associated with a given opportunity and matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId/products/:productId", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." }, { "name": "productId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity product." } ] }, "docs": "Get all product(s) that are associated with a given opportunity and matching an (optional) OData query." }, { "info": { "name": "Update an already existing opportunity.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId/products/:productId", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." }, { "name": "productId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity product." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an already existing opportunity." }, { "info": { "name": "Partially update an already existing opportunity product.", "type": "http" }, "http": { "method": "PATCH", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId/products/:productId", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." }, { "name": "productId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity product." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update an already existing opportunity product." }, { "info": { "name": "Delete a specific opportunity product.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId/products/:productId", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." }, { "name": "productId", "value": "", "type": "path", "description": "The unique identifier (id) for a given product that is associated with a opportunity." } ] }, "docs": "Delete a specific opportunity product." }, { "info": { "name": "Gets a stage.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/stages/:stageId", "params": [ { "name": "stageId", "value": "", "type": "path", "description": "The unique identifier (id) for a given stage." } ] }, "docs": "Gets a stage." }, { "info": { "name": "Update an already existing stage.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/opportunities/stages/:stageId", "params": [ { "name": "stageId", "value": "", "type": "path", "description": "The unique identifier (id) for a given process." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an already existing stage." }, { "info": { "name": "Partially update an already existing stage.", "type": "http" }, "http": { "method": "PATCH", "url": "https://apimta.act.com/act.web.api/api/opportunities/stages/:stageId", "params": [ { "name": "stageId", "value": "", "type": "path", "description": "The unique identifier (id) for a given stage." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update an already existing stage." }, { "info": { "name": "Delete a specific opportunity stage.", "type": "http" }, "http": { "method": "DELETE", "url": "https://apimta.act.com/act.web.api/api/opportunities/stages/:stageId", "params": [ { "name": "stageId", "value": "", "type": "path", "description": "The unique identifier (id) for a given stage." } ] }, "docs": "Delete a specific opportunity stage." }, { "info": { "name": "Converts an OData filter query into criteria JSON for use with dynamic list preview endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/lookup" }, "docs": "Converts an OData filter query into criteria JSON for use with dynamic list preview endpoints" }, { "info": { "name": "Get all opportunity matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities" }, "docs": "Get all opportunity matching an (optional) OData query." }, { "info": { "name": "Create a new Opportunity.", "type": "http" }, "http": { "method": "POST", "url": "https://apimta.act.com/act.web.api/api/opportunities", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Opportunity." }, { "info": { "name": "Get a list of opportunities matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunity-lists", "params": [ { "name": "ids", "value": "", "type": "query", "description": "An array of unique identifier (id) for a given tasks." } ] }, "docs": "Get a list of opportunities matching an (optional) OData query." }, { "info": { "name": "List of opportunities from a specific custom entity and matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/:entityName/:id/associated-opportunities", "params": [ { "name": "entityName", "value": "", "type": "path", "description": "The name of the custom entity." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier (id) for a given entity row" } ] }, "docs": "List of opportunities from a specific custom entity and matching an (optional) OData query." }, { "info": { "name": "Get all opportunity access levels matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId/access", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier for the opportunity." } ] }, "docs": "Get all opportunity access levels matching an (optional) OData query." }, { "info": { "name": "Update an already existing opportunity access levels accessors.", "type": "http" }, "http": { "method": "PUT", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId/access", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an already existing opportunity access levels accessors." }, { "info": { "name": "Get all processes matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/processes" }, "docs": "Get all processes matching an (optional) OData query." }, { "info": { "name": "Create a new process.", "type": "http" }, "http": { "method": "POST", "url": "https://apimta.act.com/act.web.api/api/opportunities/processes", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new process." }, { "info": { "name": "Get all product(s) that are associated with a given opportunity and matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId/products", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ] }, "docs": "Get all product(s) that are associated with a given opportunity and matching an (optional) OData query." }, { "info": { "name": "Create a new Opportunity Product.", "type": "http" }, "http": { "method": "POST", "url": "https://apimta.act.com/act.web.api/api/opportunities/:opportunityId/products", "params": [ { "name": "opportunityId", "value": "", "type": "path", "description": "The unique identifier (id) for a given opportunity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Opportunity Product." }, { "info": { "name": "Get all stages matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/stages" }, "docs": "Get all stages matching an (optional) OData query." }, { "info": { "name": "Get all stages for a given process and matching an (optional) OData query.", "type": "http" }, "http": { "method": "GET", "url": "https://apimta.act.com/act.web.api/api/opportunities/processes/:processId/stages", "params": [ { "name": "processId", "value": "", "type": "path", "description": "The unique identifier (id) for a given process." } ] }, "docs": "Get all stages for a given process and matching an (optional) OData query." }, { "info": { "name": "Create a new Stage.", "type": "http" }, "http": { "method": "POST", "url": "https://apimta.act.com/act.web.api/api/opportunities/processes/:processId/stages", "params": [ { "name": "processId", "value": "", "type": "path", "description": "The unique identifier (id) for a given process." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Stage." } ] } ], "bundled": true }