Create a project
Create
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | projects.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Action | Yes | The action to perform | action=create | |
| Input | Yes | JSON string | See below |
| JSON Input | Mandatory | Description | Examples |
|---|---|---|---|
| projectCompany | Yes | Project company | "projectCompany":43 |
| projectClientCode | No | Client code. Only pass a client code if you want the new project to be associated with a client | "projectClientCode":"43/ANIM4" |
| projectName | Yes | Project name | "projectName":"Client project 2025" |
Example request (OAuth 2.0):
creating project with a client
Authorization: Bearer <access_token>
https://<SERVER>/jsonapi/projects.json?version=6&&action=create&input={
"data": [
{
"projectName": "Client project 2025",
"projectCompany": 43,
"projectClientCode": "43/ANIM4"
}
]
}
Example request (legacy username/password):
https://<SERVER>/jsonapi/projects.json?version=6&&action=create&input={
"data": [
{
"projectName": "Client project 2025",
"projectCompany": 43,
"projectClientCode": "43/ANIM4"
}
]
}&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"synversion": "15.000.0017",
"synapiversion": 6,
"data": [
{
"projectuuid": "9914E79BF5185D429713351FC62F6012",
"projectNo": 623,
"projectTimeStampModified": 1753710052,
"projectRecordVersionNumber": 0
}
]
}