Create Custom Field Opportunity
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tool": "SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY",
"parameters": {
"label": "<string>",
"length": "<string>",
"decimalPlace": "<string>",
"pickListValues": "<string>",
"visibleLines": "<string>",
"defaultCheckboxValue": true,
"description": "<string>",
"helperText": "<string>",
"defaultFieldValue": "<string>"
}
}
'import requests
url = "https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY"
payload = {
"tool": "SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY",
"parameters": {
"label": "<string>",
"length": "<string>",
"decimalPlace": "<string>",
"pickListValues": "<string>",
"visibleLines": "<string>",
"defaultCheckboxValue": True,
"description": "<string>",
"helperText": "<string>",
"defaultFieldValue": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tool: 'SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY',
parameters: {
label: '<string>',
length: '<string>',
decimalPlace: '<string>',
pickListValues: '<string>',
visibleLines: '<string>',
defaultCheckboxValue: true,
description: '<string>',
helperText: '<string>',
defaultFieldValue: '<string>'
}
})
};
fetch('https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tool' => 'SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY',
'parameters' => [
'label' => '<string>',
'length' => '<string>',
'decimalPlace' => '<string>',
'pickListValues' => '<string>',
'visibleLines' => '<string>',
'defaultCheckboxValue' => true,
'description' => '<string>',
'helperText' => '<string>',
'defaultFieldValue' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY"
payload := strings.NewReader("{\n \"tool\": \"SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY\",\n \"parameters\": {\n \"label\": \"<string>\",\n \"length\": \"<string>\",\n \"decimalPlace\": \"<string>\",\n \"pickListValues\": \"<string>\",\n \"visibleLines\": \"<string>\",\n \"defaultCheckboxValue\": true,\n \"description\": \"<string>\",\n \"helperText\": \"<string>\",\n \"defaultFieldValue\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tool\": \"SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY\",\n \"parameters\": {\n \"label\": \"<string>\",\n \"length\": \"<string>\",\n \"decimalPlace\": \"<string>\",\n \"pickListValues\": \"<string>\",\n \"visibleLines\": \"<string>\",\n \"defaultCheckboxValue\": true,\n \"description\": \"<string>\",\n \"helperText\": \"<string>\",\n \"defaultFieldValue\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tool\": \"SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY\",\n \"parameters\": {\n \"label\": \"<string>\",\n \"length\": \"<string>\",\n \"decimalPlace\": \"<string>\",\n \"pickListValues\": \"<string>\",\n \"visibleLines\": \"<string>\",\n \"defaultCheckboxValue\": true,\n \"description\": \"<string>\",\n \"helperText\": \"<string>\",\n \"defaultFieldValue\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"created": true,
"fullName": "Opportunity.Docs_Example_Score__c",
"success": true,
"errors": []
}Tools
Create Custom Field Opportunity
POST
/
projects
/
{project_id}
/
tools
/
#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY
Create Custom Field Opportunity
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tool": "SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY",
"parameters": {
"label": "<string>",
"length": "<string>",
"decimalPlace": "<string>",
"pickListValues": "<string>",
"visibleLines": "<string>",
"defaultCheckboxValue": true,
"description": "<string>",
"helperText": "<string>",
"defaultFieldValue": "<string>"
}
}
'import requests
url = "https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY"
payload = {
"tool": "SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY",
"parameters": {
"label": "<string>",
"length": "<string>",
"decimalPlace": "<string>",
"pickListValues": "<string>",
"visibleLines": "<string>",
"defaultCheckboxValue": True,
"description": "<string>",
"helperText": "<string>",
"defaultFieldValue": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tool: 'SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY',
parameters: {
label: '<string>',
length: '<string>',
decimalPlace: '<string>',
pickListValues: '<string>',
visibleLines: '<string>',
defaultCheckboxValue: true,
description: '<string>',
helperText: '<string>',
defaultFieldValue: '<string>'
}
})
};
fetch('https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tool' => 'SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY',
'parameters' => [
'label' => '<string>',
'length' => '<string>',
'decimalPlace' => '<string>',
'pickListValues' => '<string>',
'visibleLines' => '<string>',
'defaultCheckboxValue' => true,
'description' => '<string>',
'helperText' => '<string>',
'defaultFieldValue' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY"
payload := strings.NewReader("{\n \"tool\": \"SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY\",\n \"parameters\": {\n \"label\": \"<string>\",\n \"length\": \"<string>\",\n \"decimalPlace\": \"<string>\",\n \"pickListValues\": \"<string>\",\n \"visibleLines\": \"<string>\",\n \"defaultCheckboxValue\": true,\n \"description\": \"<string>\",\n \"helperText\": \"<string>\",\n \"defaultFieldValue\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"tool\": \"SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY\",\n \"parameters\": {\n \"label\": \"<string>\",\n \"length\": \"<string>\",\n \"decimalPlace\": \"<string>\",\n \"pickListValues\": \"<string>\",\n \"visibleLines\": \"<string>\",\n \"defaultCheckboxValue\": true,\n \"description\": \"<string>\",\n \"helperText\": \"<string>\",\n \"defaultFieldValue\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://actionkit.useparagon.com/projects/{project_id}/tools/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tool\": \"SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY\",\n \"parameters\": {\n \"label\": \"<string>\",\n \"length\": \"<string>\",\n \"decimalPlace\": \"<string>\",\n \"pickListValues\": \"<string>\",\n \"visibleLines\": \"<string>\",\n \"defaultCheckboxValue\": true,\n \"description\": \"<string>\",\n \"helperText\": \"<string>\",\n \"defaultFieldValue\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"created": true,
"fullName": "Opportunity.Docs_Example_Score__c",
"success": true,
"errors": []
}Provider API: Salesforce REST API (Latest version available to the connected org).
Authorizations
Your Paragon User Token (JWT), which you can generate using your project's signing keys.
Path Parameters
Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher.
Body
application/json
Response
200 - application/json
The result of creating the custom field. created is false if the field already existed. fullName is the object name and the field API name. If adding the field to a profile or page layout fails, the field is still created and errors describes what was skipped. The keys and values in the response come from Salesforce and can vary with how the object, its fields and the org are configured, so your response may differ from this example.
Was this page helpful?