projects

Create /projects

Create a project. Required: name, client, start_date. Optional: status (defaults to tenant default), type, deadline, description, project number, cost, estimated hours, members, opportunity, contact persons, related project, organization, address, phone, schedule, learning fields, and custom fields. billing_type defaults to task hours (3). Returns record with the detail projection.

POST

/projects

Create /projects

curl --request POST \
  --url https://default.hannacrm.app/api/v4/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "billing_type": 123,
  "client": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_persons": [
    "<string>"
  ],
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "deadline": "<string>",
  "description": "<string>",
  "estimated_hours": "<string>",
  "members": [
    "<string>"
  ],
  "name": "<string>",
  "opportunity": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone": "<string>",
  "project_cost": "<string>",
  "project_number": "<string>",
  "rel_project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_date": "<string>",
  "status": "<string>",
  "type": "<string>"
}
'

{
  "record": {
    "address": "<string>",
    "billing_type": "<string>",
    "client": [
      {}
    ],
    "contact_persons": [
      {}
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "date_finished": "2023-11-07T05:31:56Z",
    "deadline": "<string>",
    "description": "<string>",
    "estimated_hours": "<string>",
    "members": [
      {}
    ],
    "name": "<string>",
    "opportunity": [
      {}
    ],
    "organization": [
      {}
    ],
    "organization_name": "<string>",
    "phone": "<string>",
    "progress": "<string>",
    "progress_from_tasks": "<string>",
    "project_cost": "<string>",
    "project_created": "2023-11-07T05:31:56Z",
    "project_number": "<string>",
    "rel_project": [
      {}
    ],
    "start_date": "<string>",
    "status": [
      {}
    ],
    "type": [
      {}
    ],
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

addressstring

Project address.

billing_typeintegerrequired

Billing type: 1=fixed cost, 2=project hourly, 3=task hourly.

clientstringrequired

Client UUID.

contact_personsstring[]

Contact person UUIDs.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

deadlinestring

Project deadline (Y-m-d).

descriptionstring

Project description (HTML allowed).

estimated_hoursstring

Estimated hours.

membersstring[]

Project member staff UUIDs. On update, replaces the full member list when sent.

namestringrequired

Project name.

opportunitystring

Related opportunity UUID.

organizationstring

Organization UUID.

phonestring

Project phone number.

project_coststring

Total project cost.

project_numberstring

Project number.

rel_projectstring

Related parent project UUID.

start_datestringrequired

Project start date (Y-m-d).

statusstring

Project status picklist value UUID. Uses tenant default when omitted on create.

typestring

Project type picklist value UUID.

Response

Success

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team