Save as PDF

Intake Management APIs

The Responsive application currently supports the following Intake Management APIs:

Intake Management API

Create Intake

API URL

/rfpserver/ext/v1/intakes/create

Description

Creates a new Intake in the company.

Type

POST

Input

{

  "additionalContacts": [],

  "category": [],

  "clientAddress1": "115 2nd Street",

  "clientAddress2": "New york",

  "clientEmail": "test@client.com",

  "clientName": "Microsoft Corporation",

  "clientPhone": "999-859-896",

  "customFields": {},

  "dealSize": 123456,

  "description": "Authorization and Authentication Questionnaire",

  "dueDate": "2023-07-06T08:03:46.334Z",

  "name": "TestEntity",

  "primaryBU": "India",

  "primaryContact": "janedoe@rfpio.com",

  "projectType": "RFP"

}

 

 

additionalContacts(array[string]optional): List of users(email addresses) to be associated. The user should be a SUPER_ADMIN or RFP_ADMIN or any role with PROJECT_PRIMARY_CONTACT additional role enabled.  The contact should belong to the same business unit if the business unit field has values.

category(string): Category of the entity.

clientAddress1 (stringoptional): Address1 of the client.

clientAddress2 (stringoptional): Address2 of the client.

clientEmail (stringoptional): Email Address of the client.

clientName (stringoptional): Name of the client.

clientPhone (stringoptional): Contact number of the client.

 

customFields (objectoptional): Custom Fields. Use customField's mergeTag name as key and appropriate value. Custom field that are marked as required are mandatory. Please refer to the list of custom fields in the Organization settings for better clarity.

dealSize (number($double), optional): Value of the deal.

description (stringoptional): A high level description/notes that explains about the entity(project/intake),

dueDate (string($date-time), required): Due data of the entity (project/intake) to be completed. It should be a future date with format, yyyy-MM-dd HH:mm:ss XXX.

name (string, required): Name of the entity.

primaryBU (stringoptional): Business unit name to be associated.

primaryContact(string, required): Primary contact of the entity(project/intake). The user should be a SUPER_ADMIN or RFP_ADMIN or any role with PROJECT_PRIMARY_CONTACT additional role enabled. The contact should belong to the same business unit if the business unit field of this project/intake has values.

projectType (string, required): Type of the entity (project/intake) from the list of various types configured in the organization settings. Allowed values can be referred from, " + "Organization settings->Project->Type.

 

Output

JSON object containing details of the intake thus created.

{

    "additionalContacts": [],

    "category": [],

    "clientAddress1": "115 2nd Street",

    "clientAddress2": "New york",

    "clientEmail": "test@client.com",

    "clientName": "Microsoft Corporation",

    "clientPhone": "999-859-896",

    "companyId": "",

    "createdBy": "",

    "createdDate": "2023-07-06T07:56:54.748Z",

    "crmDetails": {

        "instanceId": "",

        "lastUpdateTs": "2023-07-06T07:56:54.748Z",

        "objectId": "",

        "objectType": "",

        "recordId": "",

        "type": "HUBSPOT"

    },

    "customFields": {},

    "dealSize": 123456,

    "description": "Authorization and Authentication Questionnaire",

    "displayId": "",

    "dueDate": "2023-07-06T07:56:54.748Z",

    "id": "",

    "lastUpdateTs": "2023-07-06T07:56:54.748Z",

    "name": "TestEntity",

    "primaryBU": "India",

    "primaryContact": "janedoe@rfpio.com",

    "projectType": "RFP",

    "status": "IN_PROGRESS",

    "updatedBy": ""

}

 

List Intake by Status

API URL

/rfpserver/ext/v1/intakes

Description

Get the list of intakes based on its status

Type

GET

Input

limit - Limits the no of record in the response. If limit is given as -1, it returns just the total number of projects.If no limit is set, then all projects are returned in the response.

Default value : 25

 

status*  - Status of the intake. Only intake(s) with this filter status would be retrieved

Available values : ARCHIVED, CANCELED, CLOSED, CONVERTED, SUBMITTED

Default value : SUBMITTED

Output

JSON object containing details of the matching intakes.

{

  "intakes": [

    {

      "additionalContacts": [],

      "category": [],

      "clientAddress1": "115 2nd Street",

      "clientAddress2": "New york",

      "clientEmail": "test@client.com",

      "clientName": "Microsoft Corporation",

      "clientPhone": "999-859-896",

      "companyId": "",

      "createdBy": "",

      "createdDate": "2023-07-06T07:56:54.748Z",

      "crmDetails": {

        "instanceId": "",

        "lastUpdateTs": "2023-07-06T07:56:54.748Z",

        "objectId": "",

        "objectType": "",

        "recordId": "",

        "type": "HUBSPOT"

      },

      "customFields": {},

      "dealSize": 123456,

      "description": "Authorization and Authentication Questionnaire",

      "displayId": "",

      "dueDate": "2023-07-06T07:56:54.748Z",

      "id": "",

      "lastUpdateTs": "2023-07-06T07:56:54.748Z",

      "name": "TestEntity",

      "primaryBU": "India",

      "primaryContact": "janedoe@rfpio.com",

      "projectType": "RFP",

      "status": "IN_PROGRESS",

      "updatedBy": ""

    }

  ],

  "limit": 0,

  "totalResultsCount": 0

}

IntakeExternalResponseListVO {

intakes (Array[IntakeExternalResponseVO]optional),

limit (integer, optional): Limit the no of records in the response. If limit is given as -1, it returns just the total number of projects. If no limit is set, then all projects are returned in the response

totalResultsCount (integeroptional),

}

IntakeExternalResponseVO

{

additionalContacts(array[string]optional): List of users(email addresses) to be associated. The user should be a SUPER_ADMIN or RFP_ADMIN or any role with PROJECT_PRIMARY_CONTACT additional role enabled.  The contact should belong to the same business unit if the business unit field has values.

category(string): Category of the entity.

clientAddress1 (stringoptional): Address1 of the client.

clientAddress2 (stringoptional): Address2 of the client.

clientEmail (stringoptional): Email Address of the client.

clientName (stringoptional): Name of the client.

clientPhone (stringoptional): Contact number of the client.

companyId (stringoptional): Indicates the company ID

createdBy (stringoptional): Indicates who created the intake.

createdDate (date-timeoptional): Indicates the intake created date.

crmDetails (CRMDetailsoptional),

customFields (objectoptional): Custom Fields. Use customField's mergeTag name as key and appropriate value. Custom field that are marked as required are mandatory. Please refer to the list of custom fields in the Organization settings for better clarity.

dealSize (number($double), optional): Value of the deal.

description (stringoptional): A high level description/notes that explains about the entity(project/intake),

dueDate (string($date-time), required): Due data of the entity (project/intake) to be completed. It should be a future date with format, yyyy-MM-dd HH:mm:ss XXX.

id (string, optional): Indicates the file ID

lastUpdateTs (date-time, optional): Indicates the intake last updated date.

name (string, required): Name of the entity.

primaryBU (stringoptional): Business unit name to be associated.

primaryContact(string, required): Primary contact of the entity(project/intake). The user should be a SUPER_ADMIN or RFP_ADMIN or any role with PROJECT_PRIMARY_CONTACT additional role enabled. The contact should belong to the same business unit if the business unit field of this project/intake has values.

projectType (string, required): Type of the entity (project/intake) from the list of various types configured in the organization settings. Allowed values can be referred from, " + "Organization settings->Project->Type.

status (stringoptional): Indicates the intake status

updatedBy (stringoptional): Indicates who updated the intake.

}

 

 

Get Intake by ID

API URL

/rfpserver/ext/v1/intakes/{intakeId}

Description

Fetch intake based on its ID

Type

GET

Input

intakeId* - Intake ID

Output

JSON object containing details of the matching intake. 

{

  "additionalContacts": [],

  "category": [],

  "clientAddress1": "115 2nd Street",

  "clientAddress2": "New york",

  "clientEmail": "test@client.com",

  "clientName": "Microsoft Corporation",

  "clientPhone": "999-859-896",

  "companyId": "",

  "createdBy": "",

  "createdDate": "2023-07-06T07:59:14.082Z",

  "crmDetails": {

    "instanceId": "",

    "lastUpdateTs": "2023-07-06T07:59:14.082Z",

    "objectId": "",

    "objectType": "",

    "recordId": "",

    "type": "HUBSPOT"

  },

  "customFields": {},

  "dealSize": 123456,

  "description": "Authorization and Authentication Questionnaire",

  "displayId": "",

  "dueDate": "2023-07-06T07:59:14.082Z",

  "id": "",

  "lastUpdateTs": "2023-07-06T07:59:14.082Z",

  "name": "TestEntity",

  "primaryBU": "India",

  "primaryContact": "janedoe@rfpio.com",

  "projectType": "RFP",

  "status": "IN_PROGRESS",

  "updatedBy": ""

IntakeExternalResponseVO {

additionalContacts(array[string]optional): List of users(email addresses) to be associated. The user should be a SUPER_ADMIN or RFP_ADMIN or any role with PROJECT_PRIMARY_CONTACT additional role enabled.  The contact should belong to the same business unit if the business unit field has values.

category(string): Category of the entity.

clientAddress1 (stringoptional): Address1 of the client.

clientAddress2 (stringoptional): Address2 of the client.

clientEmail (stringoptional): Email Address of the client.

clientName (stringoptional): Name of the client.

clientPhone (stringoptional): Contact number of the client.

companyId (stringoptional): Indicates the company ID

createdBy (stringoptional): Indicates who created the intake.

createdDate (date-timeoptional): Indicates the intake created date.

crmDetails (CRMDetailsoptional),

customFields (objectoptional): Custom Fields. Use customField's mergeTag name as key and appropriate value. Custom field that are marked as required are mandatory. Please refer to the list of custom fields in the Organization settings for better clarity.

dealSize (number($double), optional): Value of the deal.

description (stringoptional): A high level description/notes that explains about the entity(project/intake),

displayId (stringoptional): Indicates the unique display ID. 

dueDate (string($date-time), required): Due data of the entity (project/intake) to be completed. It should be a future date with format, yyyy-MM-dd HH:mm:ss XXX. 

id (string, optional): Indicates the file ID

lastUpdateTs (date-time, optional): Indicates the intake last updated date.

 

name (string, required): Name of the entity.

primaryBU (stringoptional): Business unit name to be associated.

primaryContact(string, required): Primary contact of the entity(project/intake). The user should be a SUPER_ADMIN or RFP_ADMIN or any role with PROJECT_PRIMARY_CONTACT additional role enabled. The contact should belong to the same business unit if the business unit field of this project/intake has values.

projectType (string, required): Type of the entity (project/intake) from the list of various types configured in the organization settings. Allowed values can be referred from, " + "Organization settings->Project->Type.

updatedBy (stringoptional): Indicates who updated the intake. 

}

 

Update Intake

API URL

/rfpserver/ext/v1/intakes/update/{intakeId}

Description

Updates intake based on its ID.

Type

POST

Input

{

  "additionalContacts": [],

  "category": [],

  "clientAddress1": "115 2nd Street",

  "clientAddress2": "New york",

  "clientEmail": "test@client.com",

  "clientName": "Microsoft Corporation",

  "clientPhone": "999-859-896",

  "customFields": {},

  "dealSize": 123456,

  "description": "Authorization and Authentication Questionnaire",

  "dueDate": "2023-07-06T08:03:46.334Z",

  "name": "TestEntity",

  "primaryBU": "India",

  "primaryContact": "janedoe@rfpio.com",

  "projectType": "RFP"

}

BaseRequestExtVO {

additionalContacts(array[string]optional): List of users(email addresses) to be associated. The user should be a SUPER_ADMIN or RFP_ADMIN or any role with PROJECT_PRIMARY_CONTACT additional role enabled.  The contact should belong to the same business unit if the business unit field has values.

category(string): Category of the entity.

clientAddress1 (stringoptional): Address1 of the client.

clientAddress2 (stringoptional): Address2 of the client.

clientEmail (stringoptional): Email Address of the client.

clientName (stringoptional): Name of the client.

clientPhone (stringoptional): Contact number of the client.

 

customFields (objectoptional): Custom Fields. Use customField's mergeTag name as key and appropriate value. Custom field that are marked as required are mandatory. Please refer to the list of custom fields in the Organization settings for better clarity.

dealSize (number($double), optional): Value of the deal.

description (stringoptional): A high level description/notes that explains about the entity(project/intake),

dueDate (string($date-time), required): Due data of the entity (project/intake) to be completed. It should be a future date with format, yyyy-MM-dd HH:mm:ss XXX.

name (string, required): Name of the entity.

primaryBU (stringoptional): Business unit name to be associated.

primaryContact(string, required): Primary contact of the entity(project/intake). The user should be a SUPER_ADMIN or RFP_ADMIN or any role with PROJECT_PRIMARY_CONTACT additional role enabled. The contact should belong to the same business unit if the business unit field of this project/intake has values.

projectType (string): Type of the entity (project/intake) from the list of various types configured in the organization settings. Allowed values can be referred from, " + "Organization settings->Project->Type, 

}

Output

JSON object containing details of the matching intake.

{

      "additionalContacts": [],

      "category": [],

      "clientAddress1": "115 2nd Street",

      "clientAddress2": "New york",

      "clientEmail": "test@client.com",

      "clientName": "Microsoft Corporation",

      "clientPhone": "999-859-896",

      "companyId": "",

      "createdBy": "",

      "createdDate": "2023-07-06T07:56:54.748Z",

      "crmDetails": {

        "instanceId": "",

        "lastUpdateTs": "2023-07-06T07:56:54.748Z",

        "objectId": "",

        "objectType": "",

        "recordId": "",

        "type": "HUBSPOT"

      },

      "customFields": {},

      "dealSize": 123456,

      "description": "Authorization and Authentication Questionnaire",

      "displayId": "",

      "dueDate": "2023-07-06T07:56:54.748Z",

      "id": "",

      "lastUpdateTs": "2023-07-06T07:56:54.748Z",

      "name": "TestEntity",

      "primaryBU": "India",

      "primaryContact": "janedoe@rfpio.com",

      "projectType": "RFP",

      "status": "IN_PROGRESS",

      "updatedBy": ""

}

 

Attachment Download

API URL

/rfpserver/ext/v1/intakes/attachments/{companyId}/{fileId}

Description

Download attachment file of the Intake content.

Type

GET

Input

companyId and fileId in the URL 

In Intake records, if there are any attachments, each attachment will have companyId and fileId which can be used here to download the file. 

Output

Complete File

 

Associate CRM in Intake

API URL

/rfpserver/ext/v1/intakes/{intakeId}/update/associate-crm

Description

Update CRM Details in the Intake for Association.

Type

POST

Path Param

intakeId (Mandatory)

Input

{

    "instanceId": "",

    "lastUpdateTs": "2024-04-06T17:09:21.778Z",

    "objectId": "",

    "objectType": "",

    "recordId": "",

    "type": "ZOHO"

 }

 

instanceId (string, optional): Instance Id, user have created to establish connection to CRM

lastUpdateTs (string($date-time), optional): Updated timestamp of the entity. It should be a date with format, yyyy-MM-dd HH:mm:ss XXX

objectId (string, optional): Object ID, user have associated with the entity

objectType (string, optional): Object type, user have associated with the entity

recordId (string, optional): Record Id

type (string, optional):vCRM type

Enum:

[ GOOGLE_ADDON, HUBSPOT, LOOKUP_PROJECT, MICROSOFT_DYNAMICS_CRM, MICROSOFT_TEAMS, MS_ADDIN, PIPEDRIVE, PIPELINE_DEALS, SALESFORCE, SHAREPOINT, SLACK, ZOHO ]

Output

JSON object containing details of the intake. IntakeExternalResponseVO

{

    "additionalContacts": [],

    "category": [],

    "clientAddress1": "115 2nd Street",

    "clientAddress2": "New york",

    "clientEmail": "test@client.com",

    "clientName": "Microsoft Corporation",

    "clientPhone": "999-859-896",

    "companyId": "",

    "createdBy": "",

    "createdDate": "2023-07-06T07:56:54.748Z",

    "crmDetails": {

        "instanceId": "",

        "lastUpdateTs": "2023-07-06T07:56:54.748Z",

        "objectId": "",

        "objectType": "",

        "recordId": "",

        "type": "HUBSPOT"

    },

    "customFields": {},

    "dealSize": 123456,

    "description": "Authorization and Authentication Questionnaire",

    "displayId": "",

    "dueDate": "2023-07-06T07:56:54.748Z",

    "id": "",

    "lastUpdateTs": "2023-07-06T07:56:54.748Z",

    "name": "TestEntity",

    "primaryBU": "India",

    "primaryContact": "john@responsive.io",

    "projectType": "RFP",

    "status": "IN_PROGRESS",

    "updatedBy": ""

}

 

Dissociate CRM in Intake

API URL

/rfpserver/ext/v1/intakes/{intakeId}/update/dissociate-crm

Description

Update intake for CRM dissociation..

Type

POST

Input Path Param

intakeId (Mandatory)

Output

JSON object containing details of the intake. IntakeExternalResponseVO

{

    "additionalContacts": [],

    "category": [],

    "clientAddress1": "115 2nd Street",

    "clientAddress2": "New york",

    "clientEmail": "test@client.com",

    "clientName": "Microsoft Corporation",

    "clientPhone": "999-859-896",

    "companyId": "",

    "createdBy": "",

    "createdDate": "2023-07-06T07:56:54.748Z",

    "crmDetails": {

        "instanceId": "",

        "lastUpdateTs": "2023-07-06T07:56:54.748Z",

        "objectId": "",

        "objectType": "",

        "recordId": "",

        "type": "HUBSPOT"

    },

    "customFields": {},

    "dealSize": 123456,

    "description": "Authorization and Authentication Questionnaire",

    "displayId": "",

    "dueDate": "2023-07-06T07:56:54.748Z",

    "id": "",

    "lastUpdateTs": "2023-07-06T07:56:54.748Z",

    "name": "TestEntity",

    "primaryBU": "India",

    "primaryContact": "john@responsive.io",

    "projectType": "RFP",

    "status": "IN_PROGRESS",

    "updatedBy": ""

}

The API endpoints either start with /rfpserver. The baseUrl for most customers is app.rfpio.com. For more details, please reach out to your CSM or contact accountmanagers@responsive.io. For details on other endpoints, click here.

Was this article helpful?

/