Create ClientPoint

Description

The API allows you to create a new ClientPoint. This API endpoint enables you to specify various details and settings for the ClientPoint, including its name, estimated revenue, assigned user, division, expiration date, and more. You can also configure additional options such as test mode, import multiple documents and templates and define custom fields and recipients for the ClientPoint. By making a request to this endpoint and providing the necessary parameters in the request body, you can programmatically generate ClientPoints.

Method URL Headers
POST https://api.clientpoint.net/v4/clientpoint/create None

Request Body

Fields Data type Description Sample Data
api_key* Alpha-Numeric An alphanumeric API Key used for authenticate & authorize ClientPoint APIs. asdsad224r4332g23432443h24324e
name* String The name associated with the ClientPoint, typically representing the client or company. ABC Company
revenue* Float The estimated or expected revenue of the ClientPoint in number format. 500.50
assigned_to* Email The email address of the active user within the company who will be assigned to the ClientPoint. representative.active@yourcompany.com
division String The division of the ClientPoint, providing additional categorization if needed. North America
expiration_date Date (YYYY-MM-DD) The date when the ClientPoint is set to expire for viewers. 2024-06-15
test_mode Boolean A flag to determine whether the ClientPoint is created in a test mode (true) or not (false). true | false
file_ids Array An array containing IDs of multiple documents to import into the ClientPoint. [9173927, 8102380]
template_id Array Multiple templates to import into ClientPoint [567834, 673498]
send_recipient_mail Boolean By Default false - will not send ClientPoint
true to send ClientPoint to all recepients		 true | false
custom_fields JSON Array

Custom Fields on the Info section, multiple entries are allowed

"custom_fields":[
 {
  "tag":"location",
  "value":"Test location"
 },
{
  "tag":"pZyqqGQr",
  "value":"Test Value"
},
 {
  "tag":"Estimator",
  "value":"Test Estimator"
 }
]
recipients JSON Array

Recipients on the Info section, multiple entries are allowed

"recipients":[
 {
  "first_name":"John",
  "last_name":"Doe",
  "email":"john.doe@clientpoint.net",
  "primary":true
 },
 {
  "first_name":"Joe",
  "last_name":"Doakes",
  "email":"joe.doakes@clientpoint.net",
  "primary":false
 }
]

data JSON Object

Any addition data send which can be use after ClientPoint workflow

"data":{
  "xyz":"any value"
  .....
 }
 Copy
Requested Payload Copy
Response Copy
 Your response will appear here