/contactDeals
Retrieve all secondary contacts
200
400
GET /contactDeals
/contactDeals
Create a new secondary contact for a deal
application/json
DealCreateSecondaryContactRequest
200
422
POST /contactDeals
/contactDeals/{id}
Delete an existing secondary contact
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Secondary Contact’s id |
200
404
DELETE /contactDeals/{id}
/contactDeals/{id}
Retrieve an existing secondary contact
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Secondary Contact’s id |
200
404
GET /contactDeals/{id}
/contactDeals/{id}
Update an existing secondary contact
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Secondary Contact’s id |
application/json
DealUpdateSecondaryContactRequest
200
404
422
PUT /contactDeals/{id}
/contacts/{id}/contactDeals
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the contact |
200
404
GET /contacts/{id}/contactDeals
/contacts/{id}/deals
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the contact |
200
404
GET /contacts/{id}/deals
/dealActivities
View a recent activity for Deals. A specific deal’s activity can also be viewed using /api/3/deals/[dealID]/dealActivities.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| exclude=email | query | optional | string | Include this param to exclude “email”, “connection_email”, and “LinkData” activity types |
| deal | query | optional | string | Filter by deal ID |
| filters[data_type] | query | optional | string | Enter any dataType (see Response Details) to filter by that type. Examples: “userid” or task” or “note” |
| filters[data_id] | query | optional | string | Enter any dataId (see Response details) to filter by related object. Example “291” for a note with ID 291 |
200
400
GET /dealActivities
/dealCustomFieldData
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[dealId] | query | optional | string | Filter results by a specific deal (note that Id uses a capital I) |
200
GET /dealCustomFieldData
/dealCustomFieldData
application/json
DealCreateCustomFieldValueRequest
200
422
POST /dealCustomFieldData
/dealCustomFieldData/bulkCreate
application/json
DealBulkCreateCustomFieldValuesRequest
200
POST /dealCustomFieldData/bulkCreate
/dealCustomFieldData/bulkUpdate
application/json
DealBulkUpdateCustomFieldDataRequest
200
PATCH /dealCustomFieldData/bulkUpdate
/dealCustomFieldData/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the dealCustomFieldData to retrieve |
200
404
DELETE /dealCustomFieldData/{id}
/dealCustomFieldData/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the dealCustomFieldData to retrieve |
200
404
GET /dealCustomFieldData/{id}
/dealCustomFieldData/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the custom fields value to update |
application/json
DealUpdateCustomFieldValueRequest
200
404
422
PUT /dealCustomFieldData/{id}
/dealCustomFieldMeta
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | The number of fields returned per request. |
200
GET /dealCustomFieldMeta
/dealCustomFieldMeta
application/json
DealCreateCustomFieldMetaRequest
200
422
POST /dealCustomFieldMeta
/dealCustomFieldMeta/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the field to delete |
200
404
DELETE /dealCustomFieldMeta/{id}
/dealCustomFieldMeta/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the field to retrieve |
200
404
GET /dealCustomFieldMeta/{id}
/dealCustomFieldMeta/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | ID of the custom field to update |
application/json
DealUpdateCustomFieldMetaRequest
200
404
PUT /dealCustomFieldMeta/{id}
/dealGroups
Retrieve all existing pipelines
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[title] | query | optional | string | Filter by pipeline’s title. The filter matches any pipeline titles that contain the provided title (i.e. “Contact” matches all of “In Contact”, “To Contact”, and “Contact Pipeline”). |
| filters[have_stages] | query | optional | integer | Filter by whether pipelines have deal stages. Can be either |
| orders[title] | query | optional | string | Order by Pipeline’s title |
| orders[popular] | query | optional | string | Order by number of deals each pipeline has. If pipelines have same number of deals, pipelines’ created dates are used to determine the order. |
200
400
GET /dealGroups
/dealGroups
Create a new pipeline
application/json
DealCreatePipelineRequest
200
400
POST /dealGroups
/dealGroups/{id}
Delete an existing pipeline
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Pipeline’s id |
200
DELETE /dealGroups/{id}
/dealGroups/{id}
Retrieve an existing pipeline
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | Pipeline’s id |
200
400
GET /dealGroups/{id}
/dealGroups/{id}
Update an existing pipeline
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Pipeline’s id |
application/json
DealUpdatePipelineRequest
200
400
PUT /dealGroups/{id}
/dealRoles
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| search | query | optional | string | (optional string used to search for matching titles) |
200
400
GET /dealRoles
/dealRoles
application/json
DealRoleCreationRequest
200
400
POST /dealRoles
/dealRoles/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | Deal role’s id |
200
400
DELETE /dealRoles/{id}
/dealStages
Retrieve all existing stages
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[title] | query | optional | string | Filter by deal stages’ titles. Any stages whose titles partial-match the filter value are returned |
| filters[d_groupid] | query | optional | string | Filter by pipeline’s id |
| orders[title] | query | optional | string | Order by deal stage’s title |
200
400
GET /dealStages
/dealStages
Create a new stage for a pipeline
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| reorder | query | optional | integer | Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of |
application/json
DealCreateStageRequest
200
400
POST /dealStages
/dealStages/{id}
Delete an existing stage
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Deal stage’s id |
200
DELETE /dealStages/{id}
/dealStages/{id}
Retrieve an existing stage
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Deal stage’s id |
200
400
GET /dealStages/{id}
/dealStages/{id}
Update an existing stage
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Deal stage’s id |
| reorder | query | optional | integer | Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of |
application/json
DealUpdateStageRequest
200
400
PUT /dealStages/{id}
/dealStages/{id}/deals
Move all deals in one stage to another stage
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Deal stage’s id whose deals are to be moved to another deal stage |
application/json
DealMoveDealsToAnotherStageRequest
200
422
PUT /dealStages/{id}/deals
/dealTasks
Retrieve a list of existing tasks
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[title] | query | optional | string | The title to be assigned to the task |
| filters[reltype] | query | optional | string | The name of the relating object (see relationships table) |
| filters[relid] | query | optional | integer | The id of the relational object for this task |
| filters[status] | query | optional | integer | Task status means complete or incomplete. 1 is complete and 0 is incomplete. |
| filters[note] | query | optional | string | The content describing the task |
| filters[duedate] | query | optional | string | Due date of the task |
| filters[d_tasktypeid] | query | optional | integer | The type of the task based on the available Task Types in the account |
| filters[userid] | query | optional | integer | User ID this task belongs to |
| filters[due_after] | query | optional | string | Filter deal tasks that are due after a specific date |
| Fitlers[due_before] | query | optional | string | Filter deal tasks that are due before a specific date |
| filters[duedate_range] | query | optional | string | Filter deal tasks that are due between specific date range |
| filters[assignee_userid] | query | optional | integer | The id of the user a task is assigned to |
| filters[outcome_id] | query | optional | integer | The id of a task outcome that the task belongs to. |
201
400
GET /dealTasks
/dealTasks
Create a new task
application/json
DealCreateNewTaskRequest
201
400
POST /dealTasks
/dealTasks/{id}
Delete an existing task
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | The task id |
200
400
DELETE /dealTasks/{id}
/dealTasks/{id}
Retrieve an existing task
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | The ID of the task |
201
400
GET /dealTasks/{id}
/dealTasks/{id}
Update an existing task
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | The ID of the task |
application/json
DealUpdateTaskByIdRequest
201
400
PUT /dealTasks/{id}
/dealTasktypes
Retrieve all existing task types
200
400
GET /dealTasktypes
/dealTasktypes
Create a new task type
application/json
DealCreateTaskTypeRequest
200
400
POST /dealTasktypes
/dealTasktypes/{id}
Delete an existing task type
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Deal task type’s id |
403
DELETE /dealTasktypes/{id}
/dealTasktypes/{id}
Retrieve an existing task type
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Deal task type’s id |
200
400
GET /dealTasktypes/{id}
/dealTasktypes/{id}
Update an existing task type
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Deal task type’s id |
application/json
DealUpdateTaskTypeRequest
200
400
PUT /dealTasktypes/{id}
/dealTasktypes/{id}/dealTasks
Move tasks to a different task type
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Deal task type’s id |
application/json
DealMoveTasksToAnotherTaskTypeRequest
200
400
PUT /dealTasktypes/{id}/dealTasks
/deals
Retrieve all existing deals
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| filters[search] | query | optional | string | Search text to use with |
| filters[search_field] | query | optional | string | Field to search for. See available values. |
| filters[title] | query | optional | string | Filter by deal’s title |
| filters[stage] | query | optional | integer | Filter by deal’s stage |
| filters[group] | query | optional | integer | Filter by deal’s pipeline |
| filters[status] | query | optional | integer | Filter by deal’s status. See available values |
| filters[owner] | query | optional | integer | Filter by deal’s owner |
| filters[nextdate_range] | query | optional | string | Filter by deal’s tasks due dates. See available values |
| filters[tag] | query | optional | string | Filter by tag names associated with deal’s primary contact. See available values. |
| filters[tasktype] | query | optional | string | Filter by deals that have tasks with given type |
| filters[created_before] | query | optional | string | Returns deals that are created less than given date |
| filters[created_after] | query | optional | string | Returns deals that are created greater than or equal to given date |
| filters[updated_before] | query | optional | string | Returns deals that are updated less than given date |
| filters[updated_after] | query | optional | string | Returns deals that are updated greater than or equal to given date |
| filters[organization] | query | optional | integer | Filter by deal’s primary contact’s organization’s id |
| filters[minimum_value] | query | optional | integer | In USD with dollar portion. Returns deals whose values are greater than or equal to given value |
| filters[maximum_value] | query | optional | integer | In USD with dollar portion. Returns deals whose values are less than or equal to given value |
| filters[score_greater_than] | query | optional | string | In a format of |
| filters[score_less_than] | query | optional | string | In a format of |
| filters[score] | query | optional | string | In a format of |
| orders[title] | query | optional | string | Order by deal’s title. |
| orders[value] | query | optional | string | Order by deal’s value. |
| orders[cdate] | query | optional | string | Order by deal’s created date. |
| orders[contact_name] | query | optional | string | Order by deal’s primary contact’s first name. |
| orders[contact_orgname] | query | optional | string | Order by deal’s primary contact’s organization name. |
| orders[next-action] | query | optional | string | Order by deal’s next task’s due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal’s id. |
200
400
GET /deals
/deals
Create a new deal
application/json
DealNewDealCreationRequest
201
400
POST /deals
/deals/bulkUpdate
Update an existing deal
application/json
DealBulkUpdateOwnersRequest
200
422
PATCH /deals/bulkUpdate
/deals/{id}
Delete an existing deal
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | The Deal’s id |
200
400
DELETE /deals/{id}
/deals/{id}
Retrieve an existing deal
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | The Deal’s id |
200
GET /deals/{id}