{"_id":"59d801a69ab9f9001caecb39","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"user":"5588b847f6c18d0d005bba01","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-06T22:20:22.599Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"{\n\t\"id\": \"0061I000001fbSjQAI\",\n  \"success\": true,\n  \"errors\": []\n}","language":"json","status":200}]},"examples":{"codes":[{"code":"curl -X POST --header \"X-API-Token: <your token>\" --header \"Content-Type: application/json\" -d '{\"Name\":\"Mixmax Opportunity\",\"StageName\":\"Qualification\",\"Amount\":\"100\",\"CloseDate\":\"2017-10-06\"}' https://api.mixmax.com/v1/salesforce/opportunity","language":"curl"}]},"method":"post","auth":"required","params":[{"_id":"59d801a69ab9f9001caecb3c","ref":"","in":"body","required":true,"desc":"The Opportunity Name","default":"","type":"string","name":"Name"},{"_id":"59d801a69ab9f9001caecb3b","ref":"","in":"body","required":true,"desc":"The Opportunity Stage (view  `/salesforce/syncedFields?type=Opportunity` for valid stages).","default":"","type":"string","name":"StageName"},{"_id":"59d801a69ab9f9001caecb3a","ref":"","in":"body","required":true,"desc":"A date string for when this opportunity closes.","default":"","type":"yyyy-mm-dd","name":"CloseDate"}],"url":"/v1/salesforce/opportunity"},"isReference":true,"order":90,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"id\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The Task's Salesforce Id\",\n    \"1-0\": \"success\",\n    \"1-1\": \"Boolean\",\n    \"1-2\": \"True if the Task was successfully created, and false otherwise.\",\n    \"2-0\": \"errors\",\n    \"2-1\": \"Object[]\",\n    \"2-2\": \"A list of errors if creating the Task was not successful\",\n    \"3-0\": \"errors.name\",\n    \"3-1\": \"String\",\n    \"3-2\": \"A Salesforce error name.\",\n    \"4-0\": \"errors.errorCode\",\n    \"4-1\": \"String\",\n    \"4-2\": \"The Salesforce error code.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\nTo find available fields, try [/salesforce/syncedFields?type=Opportunity](doc:salesforcesyncedfields).","excerpt":"Create a new Salesforce Opportunity","slug":"salesforceopportunity","type":"endpoint","title":"/salesforce/opportunity"}

post/salesforce/opportunity

Create a new Salesforce Opportunity

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

Name:
required
string
The Opportunity Name
StageName:
required
string
The Opportunity Stage (view `/salesforce/syncedFields?type=Opportunity` for valid stages).
CloseDate:
required
yyyy-mm-dd
A date string for when this opportunity closes.

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "id", "0-1": "String", "0-2": "The Task's Salesforce Id", "1-0": "success", "1-1": "Boolean", "1-2": "True if the Task was successfully created, and false otherwise.", "2-0": "errors", "2-1": "Object[]", "2-2": "A list of errors if creating the Task was not successful", "3-0": "errors.name", "3-1": "String", "3-2": "A Salesforce error name.", "4-0": "errors.errorCode", "4-1": "String", "4-2": "The Salesforce error code." }, "cols": 3, "rows": 5 } [/block] To find available fields, try [/salesforce/syncedFields?type=Opportunity](doc:salesforcesyncedfields).

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}