This page is about an old version of Active Collab that's not developed anymore.
Click here to open the documentation for the latest version.

Working with Project Requests

Project Requests are a feature that helps your Clients submit new project requests. Requests can be discussed, approved and converted to Quotes or Projects. More about this feature can be found in Project Requests.

Project Requests are submitted via public forms generated by activeCollab. After creating a page, your Clients will be able to access it and fill out the form. By using the activeCollab API, you can create your own project request page and use it for data submission.

New Project Request for a New Client #

In order to create a new Project Request for a Client who does not have a User account in activeCollab, create a valid POST request at projects/requests/add with the following POST variables:

  • project_request[name] - The name of the project that the client can request from you.
  • project_request[body] - The description of the project that the client is requesting.
  • project_request[custom_field_1] to project_request[custom_field_5] - If enabled, the values of Custom Fields.
  • client_type - This value is mandatory. Possible values are new_client and existing_client.
  • new_client[created_by_company_name] - The name of the client company.
  • new_client[created_by_company_address] - The address of the client company.
  • new_client[created_by_name] - The name of the contact person.
  • new_client[created_by_email] - The email address of the contact person.
  • submitted - This value is necessary for request submission.

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
<project_request>
  <id>1</id>
  <name> ... </name>
  <permalink> ... </permalink>
  <body> ... </body>
  <body_formatted> ... </body_formatted>
  <created_on> ... </created_on>
  <created_by> ... </created_by>
  <created_by_company> ... </created_by_company>
  <custom_fields> ... </custom_fields>
  ... 
</project_request>

New Project Request for an Existing Client #

In order to create a new Project Request for an existing client (they already have a company profile and contact person defined in the People section of your activeCollab), make a valid POST request at projects/requests/add with following POST variables:

  • project_request[name] - The name of the project that the client is requesting.
  • project_request[body] - The description of the requested project.
  • project_request[custom_field_1] to project_request[custom_field_5] - If enabled, the values of Custom Fields.
  • client_type - The existing_client value is mandatory.
  • client[created_by_company_id] - The ID of the client company.
  • client[created_by_company_address] - The address of the client company (optional).
  • client[created_by_id] - The ID of the contact person for the client company.
  • submitted - Complete the submission with this value.

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
<project_request>
  <id>1</id>
  <name> ... </name>
  <permalink> ... </permalink>
  <body> ... </body>
  <body_formatted> ... </body_formatted>
  <created_on> ... </created_on>
  <created_by> ... </created_by>
  <created_by_company> ... </created_by_company>
  <custom_fields> ... </custom_fields>
  ... 
</project_request>
« Prev
Back to the Top
Next »