Create a custom field
curl --request POST \
--url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "some string",
"position": 0,
"permission": "1,2,3",
"is_active": true,
"object": "customer",
"field_widget_id": 1
}
'import requests
url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields"
payload = {
"name": "some string",
"position": 0,
"permission": "1,2,3",
"is_active": True,
"object": "customer",
"field_widget_id": 1
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'some string',
position: 0,
permission: '1,2,3',
is_active: true,
object: 'customer',
field_widget_id: 1
})
};
fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": false,
"response": {}
}{
"error": true,
"errors": [
"error message",
"error message"
]
}{
"message": "Unauthorized"
}{
"message": "Request URL not found"
}{
"message": "Internal Server Error"
}Custom Fields
Create a custom field
POST
/
custom-fields
Create a custom field
curl --request POST \
--url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "some string",
"position": 0,
"permission": "1,2,3",
"is_active": true,
"object": "customer",
"field_widget_id": 1
}
'import requests
url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields"
payload = {
"name": "some string",
"position": 0,
"permission": "1,2,3",
"is_active": True,
"object": "customer",
"field_widget_id": 1
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'some string',
position: 0,
permission: '1,2,3',
is_active: true,
object: 'customer',
field_widget_id: 1
})
};
fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/custom-fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": false,
"response": {}
}{
"error": true,
"errors": [
"error message",
"error message"
]
}{
"message": "Unauthorized"
}{
"message": "Request URL not found"
}{
"message": "Internal Server Error"
}Body raw (json)
{
"name": "some string",// required | string | max:255 | unique for the user company
"position": 0,// required | numeric
"permission": "1,2,3",// required | string | max:255 | description: commaseparated string of user rules, for example 1,2,3
"is_active": true,// required | boolean
"object": "customer",// required | string | acceptable_values: customer,job,project,invoice,asset,job_visit,maintenance_agreement,order | description: the type of custom field
"can_customer_view": true,// boolean
"field_widget_id": 1,// required | integer | existing custom field widget id
"settings": {// array
"field_instance_id": 1,// required | existing custom field instance id
"allowed_values": ["value_1", "value_2"],// nullable | array
"default_value": "value_1"// nullable | array
}
}
Authorizations
Body
application/json
Unique for the user company.
Maximum string length:
255Comma-separated string of user rules, for example 1,2,3.
Maximum string length:
255The type of custom field.
Available options:
customer, job, project, invoice, asset, job_visit, maintenance_agreement, order Existing custom field widget id.