Create a project
curl --request POST \
--url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/projects \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{}'import requests
url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/projects"
payload = {}
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({})
};
fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/projects', 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"
}Projects
Create a project
Create a project
POST
/
projects
Create a project
curl --request POST \
--url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/projects \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{}'import requests
url = "https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/projects"
payload = {}
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({})
};
fetch('https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/projects', 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)
{
"customer_id",// nullable | integer | existing customer id
"name",// optional | string | max:255
"description",// optional | string | max:1000
"status",// optional | integer | acceptable_values: 1(opportunity),2(accepted),3(planning),4(in progress),5(pending),6(completed),7(canceled)
"status_id",// optional | integer | existing custom status id
"status_workflow_id",// optional | integer | existing status workflow id
"location_id",// optional | integer | existing location id
"location",// optional | string | max:5000 | description: Location string like "Street 1, City, State, Zip code"
"start_time",// optional | timestamp
"end_time",// optional | timestamp
"notes",// optional | string | max:7500
"job_notes",// nullable | string | max:1000
"completion_percentage",// optional | string | digits_between:0,100
"customfields": [ // optional | array | description: array of custom fleds
{
"id", // optional | nullable | required if field_instance_id is not set | integer | custom field id
"field_instance_id", // optional | nullable | required if id is not set | integer | custom field instance id
"value" // required | string | custom value
},
{
"id", // optional | nullable | required if field_instance_id is not set | integer | custom field id
"field_instance_id", // optional | nullable | required if id is not set | integer | custom field instance id
"value" // required | string | custom value
}
]
}
Authorizations
Body
application/json
Existing customer id.
Maximum string length:
255Maximum string length:
10001 = opportunity, 2 = accepted, 3 = planning, 4 = in progress, 5 = pending, 6 = completed, 7 = canceled.
Available options:
1, 2, 3, 4, 5, 6, 7 Existing custom status id.
Existing status workflow id.
Existing location id.
Location string like "Street 1, City, State, Zip code".
Maximum string length:
5000Unix timestamp.
Unix timestamp.
Maximum string length:
7500Maximum string length:
1000A whole number from 0 to 100.