Create project

post https://classic-api.contractorscloud.com/api/v1/projects

Creates a new project.

🎓 Gather your Data: Creating a Project requires you to collect a handful of data and required ids ahead of time. Take a look at the Common examples section to get a better understanding of what is involved.

📌 Site Type: For the required site_type_id field, you will need to hit the Read available options endpoint to get a listing of available SiteTypes. When hitting this endpoint set the type path param to site-type.

❗ Required Fields: Depending on the Company a project is being created for, there may be additional CustomFields which will be required for Project creation. Additionally, fields such as workflow_id and name may also be required and their requirement is dictated by the corresponding Company settings.

Body Params

company_id

int32

required

The id of the Company the project belongs to

account_id

int32

required

The id of the Account the project belongs to

contact_ids

array of int32s

required

The ids of Contacts related to the project

contact_ids*

site_type_id

int32

required

The id of the SiteType for the project

lead_id

int32

required

The id of the Lead the project belongs to

referred_by

int32

The id of the user who referred the project

event_id

int32

required

The id of the Event the Project belongs to

workflow_id

int32

The id of the Workflow the Project belongs to

rep_primary_id

int32

The id of the User that is the primary rep on the Project

company_custom_fields

array of objects

Any custom fields that are required by the Company when creating a new Project

company_custom_fields

name

string

The Project name

address_street

string

required

address_city

string

required

address_state

string

required

What state the project is located in (MN, TX, CA)

address_zip

string

required

address_description

string

An optional description or note for the Project address

needs_appointment

boolean

Defaults to false

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://classic-api.contractorscloud.com/api/v1/projects \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "needs_appointment": false
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

422422