Deals

Deals represent ongoing, lost or won sales to an Organization or to a Person. Each deal has a monetary value and must be placed in a Stage. Deals can be owned by a User, and followed by one or many Users. Each Deal consists of standard data fields but can also contain a number of custom fields. The custom fields can be recognized by long hashes as keys. These hashes can be mapped against DealField.key. The corresponding label for each such custom field can be obtained from DealField.name.

Get all deals

Copy link
Copy to clipboard
GET

/v1/deals

Returns all deals. For more information on how to get all deals, see this tutorial.

Query parameters

user_id

integer

If supplied, only deals matching the given user will be returned. However, filter_id and owned_by_you takes precedence over user_id when supplied.

filter_id

integer

ID of the filter to use

stage_id

integer

If supplied, only deals within the given stage will be returned.

status

string

Only fetch deals with specific status. If omitted, all not deleted deals are fetched.

Default

all_not_deleted

Values

open

won

lost

deleted

all_not_deleted

start

integer

Pagination start

Default

0

limit

integer

Items shown per page

sort

string

Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).

owned_by_you

number

When supplied, only deals owned by you are returned. However, filter_id takes precedence over owned_by_you when both are supplied.

Values

0

1

Response
200

Get all Deals

Expand all
Copy code
    • true
    • [ ... ]
      • { ... }
        • { ... }

        Search deals

        Copy link
        Copy to clipboard
        GET

        /v1/deals/search

        Searches all Deals by title, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found Deals can be filtered by Person ID and Organization ID.

        Query parameters

        term

        string

        required

        The search term to look for. Minimum 2 characters (or 1 if using exact_match).

        fields

        string

        A comma-separated string array. The fields to perform the search from. Defaults to all of them.

        Values

        custom_fields

        notes

        title

        exact_match

        boolean

        When enabled, only full exact matches against the given term are returned. It is not case sensitive.

        Values

        true

        false

        person_id

        integer

        Will filter Deals by the provided Person ID. The upper limit of found Deals associated with the Person is 2000.

        organization_id

        integer

        Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.

        status

        string

        Will filter Deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found Deals associated with the status is 2000.

        Values

        open

        won

        lost

        include_fields

        string

        Supports including optional fields in the results which are not provided by default.

        Values

        deal.cc_email

        start

        integer

        Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.

        Default

        0

        limit

        integer

        Items shown per page

        Response
        200

        success

        Expand all
        Copy code
          • true
          • { ... }
            • { ... }

            Find deals by name

            Copy link
            Copy to clipboard
            GET

            /v1/deals/find

            Deprecated endpoint

            This endpoint is deprecated. Please use /v1/deals/search or /v1/itemSearch instead.
            Searches all deals by their title.

            Query parameters

            term

            string

            required

            Search term to look for

            person_id

            integer

            ID of the person the Deal is associated with.

            org_id

            integer

            ID of the organization the Deal is associated with.

            Response
            200

            Get Deals by name

            Expand all
            Copy code
              • true
              • [ ... ]
                • { ... }

                Get deals summary

                Copy link
                Copy to clipboard
                GET

                /v1/deals/summary

                Returns summary of all the deals.

                Query parameters

                status

                string

                Only fetch deals with specific status. open = Open, won = Won, lost = Lost

                Values

                open

                won

                lost

                filter_id

                integer

                user_id will not be considered. Only deals matching the given filter will be returned.

                user_id

                integer

                Only deals matching the given user will be returned. user_id will not be considered if you use filter_id.

                stage_id

                integer

                Only deals within the given stage will be returned.

                Response
                200

                Get the summary of the Deals

                Expand all
                Copy code
                  • true
                  • { ... }

                  Get deals timeline

                  Copy link
                  Copy to clipboard
                  GET

                  /v1/deals/timeline

                  Returns open and won deals, grouped by defined interval of time set in a date-type dealField (field_key) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given field_key.

                  Query parameters

                  start_date

                  string

                  required

                  Date where the first interval starts. Format: YYYY-MM-DD

                  Format

                  date

                  interval

                  string

                  required

                  The type of interval

                  ValueDescription
                  dayDay
                  weekA full week (7 days) starting from start_date
                  monthA full month (depending on the number of days in given month) starting from start_date
                  quarterA full quarter (3 months) starting from start_date

                  Values

                  day

                  week

                  month

                  quarter

                  amount

                  integer

                  required

                  The number of given intervals, starting from start_date, to fetch. E.g. 3 (months).

                  field_key

                  string

                  required

                  The date field key which deals will be retrieved from

                  user_id

                  integer

                  If supplied, only deals matching the given user will be returned.

                  pipeline_id

                  integer

                  If supplied, only deals matching the given pipeline will be returned

                  filter_id

                  integer

                  If supplied, only deals matching the given filter will be returned

                  exclude_deals

                  number

                  Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.

                  Values

                  0

                  1

                  totals_convert_currency

                  string

                  3-letter currency code of any of the supported currencies. When supplied, totals_converted is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to default_currency in which case users default currency is used.

                  Response
                  200

                  Get open and won Deals, grouped by the defined interval of time

                  Expand all
                  Copy code
                    • true
                    • [ ... ]

                    Get details of a deal

                    Copy link
                    Copy to clipboard
                    GET

                    /v1/deals/{id}

                    Returns details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the key value of dealFields. For more information on how to get all details of a deal, see this tutorial.

                    Path parameters

                    id

                    integer

                    required

                    ID of the deal

                    Response
                    200

                    Get a Deal by its ID

                    Expand all
                    Copy code
                      • true
                      • { ... }
                        • { ... }
                          • { ... }

                          List activities associated with a deal

                          Copy link
                          Copy to clipboard
                          GET

                          /v1/deals/{id}/activities

                          Lists activities associated with a deal.

                          Path parameters

                          id

                          integer

                          required

                          ID of the deal

                          Query parameters

                          start

                          integer

                          Pagination start

                          Default

                          0

                          limit

                          integer

                          Items shown per page

                          done

                          number

                          Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.

                          Values

                          0

                          1

                          exclude

                          string

                          A comma-separated string of activity IDs to exclude from result

                          Response
                          200

                          success

                          Expand all
                          Copy code
                            • true
                            • [ ... ]
                              • { ... }
                                • { ... }

                                List files attached to a deal

                                Copy link
                                Copy to clipboard
                                GET

                                /v1/deals/{id}/files

                                Lists files associated with a deal.

                                Path parameters

                                id

                                integer

                                required

                                ID of the deal

                                Query parameters

                                start

                                integer

                                Pagination start

                                Default

                                0

                                limit

                                integer

                                Items shown per page

                                include_deleted_files

                                number

                                When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.

                                Values

                                0

                                1

                                sort

                                string

                                Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.

                                Response
                                200

                                success

                                Expand all
                                Copy code
                                  • true
                                  • [ ... ]
                                    • { ... }

                                    List updates about a deal

                                    Copy link
                                    Copy to clipboard
                                    GET

                                    /v1/deals/{id}/flow

                                    Lists updates about a deal.

                                    Path parameters

                                    id

                                    integer

                                    required

                                    ID of the deal

                                    Query parameters

                                    start

                                    integer

                                    Pagination start

                                    Default

                                    0

                                    limit

                                    integer

                                    Items shown per page

                                    all_changes

                                    string

                                    Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

                                    items

                                    string

                                    A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)

                                    Response
                                    200

                                    Get the Deal Updates

                                    Expand all
                                    Copy code
                                      • true
                                      • [ ... ]
                                        • { ... }
                                          • { ... }

                                          List followers of a deal

                                          Copy link
                                          Copy to clipboard
                                          GET

                                          /v1/deals/{id}/followers

                                          Lists the followers of a deal.

                                          Path parameters

                                          id

                                          integer

                                          required

                                          ID of the deal

                                          Response
                                          200

                                          success

                                          Expand all
                                          Copy code
                                            • true
                                            • [ ... ]
                                              • { ... }

                                              List mail messages associated with a deal

                                              Copy link
                                              Copy to clipboard
                                              GET

                                              /v1/deals/{id}/mailMessages

                                              Lists mail messages associated with a deal.

                                              Path parameters

                                              id

                                              integer

                                              required

                                              ID of the deal

                                              Query parameters

                                              start

                                              integer

                                              Pagination start

                                              Default

                                              0

                                              limit

                                              integer

                                              Items shown per page

                                              Response
                                              200

                                              success

                                              Expand all
                                              Copy code
                                                • true
                                                • [ ... ]
                                                  • { ... }

                                                  List participants of a deal

                                                  Copy link
                                                  Copy to clipboard
                                                  GET

                                                  /v1/deals/{id}/participants

                                                  Lists participants associated with a deal.

                                                  Path parameters

                                                  id

                                                  integer

                                                  required

                                                  ID of the deal

                                                  Query parameters

                                                  start

                                                  integer

                                                  Pagination start

                                                  Default

                                                  0

                                                  limit

                                                  integer

                                                  Items shown per page

                                                  Response
                                                  200

                                                  Get all Deal participants by the DealID

                                                  Expand all
                                                  Copy code
                                                    • true
                                                    • [ ... ]
                                                      • { ... }
                                                        • { ... }

                                                        List permitted users

                                                        Copy link
                                                        Copy to clipboard
                                                        GET

                                                        /v1/deals/{id}/permittedUsers

                                                        List users permitted to access a deal

                                                        Path parameters

                                                        id

                                                        integer

                                                        required

                                                        ID of the deal

                                                        Response
                                                        200

                                                        success

                                                        Expand all
                                                        Copy code
                                                          • true
                                                          • { ... }

                                                          List all persons associated with a deal

                                                          Copy link
                                                          Copy to clipboard
                                                          GET

                                                          /v1/deals/{id}/persons

                                                          Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.

                                                          Path parameters

                                                          id

                                                          integer

                                                          required

                                                          ID of the deal

                                                          Query parameters

                                                          start

                                                          integer

                                                          Pagination start

                                                          Default

                                                          0

                                                          limit

                                                          integer

                                                          Items shown per page

                                                          Response
                                                          200

                                                          success

                                                          Expand all
                                                          Copy code
                                                            • true
                                                            • [ ... ]
                                                              • { ... }
                                                                • { ... }

                                                                List products attached to a deal

                                                                Copy link
                                                                Copy to clipboard
                                                                GET

                                                                /v1/deals/{id}/products

                                                                Lists products attached to a deal.

                                                                Path parameters

                                                                id

                                                                integer

                                                                required

                                                                ID of the deal

                                                                Query parameters

                                                                start

                                                                integer

                                                                Pagination start

                                                                Default

                                                                0

                                                                limit

                                                                integer

                                                                Items shown per page

                                                                include_product_data

                                                                number

                                                                Whether to fetch product data along with each attached product (1) or not (0, default).

                                                                Values

                                                                0

                                                                1

                                                                Response
                                                                200

                                                                success

                                                                Expand all
                                                                Copy code
                                                                  • true
                                                                  • [ ... ]
                                                                    • { ... }
                                                                      • { ... }

                                                                      Add a deal

                                                                      Copy link
                                                                      Copy to clipboard
                                                                      POST

                                                                      /v1/deals

                                                                      Adds a new deal. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys. To determine which custom fields exists, fetch the dealFields and look for key values. For more information on how to add a deal, see this tutorial.

                                                                      Body parameters

                                                                      application/json

                                                                      title

                                                                      string

                                                                      required

                                                                      Deal title

                                                                      value

                                                                      string

                                                                      Value of the deal. If omitted, value will be set to 0.

                                                                      currency

                                                                      string

                                                                      Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.

                                                                      user_id

                                                                      integer

                                                                      The ID of the User which will be the owner of the created Deal. If not provided, the user making the request will be used.

                                                                      person_id

                                                                      integer

                                                                      The ID of a Person which this Deal will be linked to. If the Person does not exist yet, it needs to be created first. This property is required unless org_id is specified.

                                                                      org_id

                                                                      integer

                                                                      The ID of an Organization which this Deal will be linked to. If the Organization does not exist yet, it needs to be created first. This property is required unless person_id is specified.

                                                                      stage_id

                                                                      integer

                                                                      The ID of a stage this Deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id). If omitted, the deal will be placed in the first stage of the default pipeline.

                                                                      status

                                                                      string

                                                                      open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.

                                                                      Values

                                                                      open

                                                                      won

                                                                      lost

                                                                      lost

                                                                      deleted

                                                                      expected_close_date

                                                                      string

                                                                      The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD.

                                                                      Format

                                                                      date

                                                                      probability

                                                                      number

                                                                      Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled.

                                                                      lost_reason

                                                                      string

                                                                      Optional message about why the deal was lost (to be used when status=lost)

                                                                      visible_to

                                                                      Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.

                                                                      ValueDescription
                                                                      1Owner & followers (private)
                                                                      3Entire company (shared)

                                                                      Values

                                                                      1

                                                                      3

                                                                      add_time

                                                                      string

                                                                      Optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

                                                                      Response
                                                                      200

                                                                      Add a Deal

                                                                      Expand all
                                                                      Copy code
                                                                        • true
                                                                        • { ... }
                                                                          • { ... }
                                                                            • { ... }

                                                                            Duplicate deal

                                                                            Copy link
                                                                            Copy to clipboard
                                                                            POST

                                                                            /v1/deals/{id}/duplicate

                                                                            Duplicate a deal

                                                                            Path parameters

                                                                            id

                                                                            integer

                                                                            required

                                                                            ID of the deal

                                                                            Response
                                                                            200

                                                                            Duplicate a Deal

                                                                            Expand all
                                                                            Copy code
                                                                              • true
                                                                              • { ... }

                                                                              Add a follower to a deal

                                                                              Copy link
                                                                              Copy to clipboard
                                                                              POST

                                                                              /v1/deals/{id}/followers

                                                                              Adds a follower to a deal.

                                                                              Path parameters

                                                                              id

                                                                              integer

                                                                              required

                                                                              ID of the deal

                                                                              Body parameters

                                                                              application/json

                                                                              user_id

                                                                              integer

                                                                              required

                                                                              ID of the user

                                                                              Response
                                                                              200

                                                                              Add a Follower to a Deal

                                                                              Expand all
                                                                              Copy code
                                                                                • true
                                                                                • { ... }

                                                                                Add a participant to a deal

                                                                                Copy link
                                                                                Copy to clipboard
                                                                                POST

                                                                                /v1/deals/{id}/participants

                                                                                Adds a participant to a deal.

                                                                                Path parameters

                                                                                id

                                                                                integer

                                                                                required

                                                                                ID of the deal

                                                                                Body parameters

                                                                                application/json

                                                                                person_id

                                                                                integer

                                                                                required

                                                                                ID of the person

                                                                                Response
                                                                                200

                                                                                Add new participant to the Deal

                                                                                Expand all
                                                                                Copy code
                                                                                  • true
                                                                                  • { ... }
                                                                                    • { ... }

                                                                                    Add a product to the deal, eventually creating a new item called a deal-product

                                                                                    Copy link
                                                                                    Copy to clipboard
                                                                                    POST

                                                                                    /v1/deals/{id}/products

                                                                                    Adds a product to the deal.

                                                                                    Path parameters

                                                                                    id

                                                                                    integer

                                                                                    required

                                                                                    ID of the deal

                                                                                    Body parameters

                                                                                    application/json

                                                                                    item_price

                                                                                    number

                                                                                    Price at which this product will be added to the deal

                                                                                    quantity

                                                                                    integer

                                                                                    Quantity – e.g. how many items of this product will be added to the deal

                                                                                    discount_percentage

                                                                                    number

                                                                                    Discount %. If omitted, will be set to 0

                                                                                    Default

                                                                                    0

                                                                                    duration

                                                                                    number

                                                                                    Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)

                                                                                    Default

                                                                                    1

                                                                                    product_variation_id

                                                                                    integer

                                                                                    ID of the product variation to use. When omitted, no variation will be used.

                                                                                    comments

                                                                                    string

                                                                                    Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.

                                                                                    enabled_flag

                                                                                    Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.

                                                                                    Values

                                                                                    0

                                                                                    1

                                                                                    product_id

                                                                                    integer

                                                                                    required

                                                                                    ID of the product that will be attached

                                                                                    Response
                                                                                    200

                                                                                    Add a Product to the Deal

                                                                                    Expand all
                                                                                    Copy code
                                                                                      • true
                                                                                      • { ... }

                                                                                      Update a deal

                                                                                      Copy link
                                                                                      Copy to clipboard
                                                                                      PUT

                                                                                      /v1/deals/{id}

                                                                                      Updates the properties of a deal. For more information on how to update a deal, see this tutorial.

                                                                                      Path parameters

                                                                                      id

                                                                                      integer

                                                                                      required

                                                                                      ID of the deal

                                                                                      Body parameters

                                                                                      application/json

                                                                                      title

                                                                                      string

                                                                                      Deal title

                                                                                      value

                                                                                      string

                                                                                      Value of the deal. If omitted, value will be set to 0.

                                                                                      currency

                                                                                      string

                                                                                      Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.

                                                                                      user_id

                                                                                      integer

                                                                                      The ID of the User which will be the owner of the created Deal. If not provided, the user making the request will be used.

                                                                                      person_id

                                                                                      integer

                                                                                      The ID of a Person which this Deal will be linked to. If the Person does not exist yet, it needs to be created first. This property is required unless org_id is specified.

                                                                                      org_id

                                                                                      integer

                                                                                      The ID of an Organization which this Deal will be linked to. If the Organization does not exist yet, it needs to be created first. This property is required unless person_id is specified.

                                                                                      stage_id

                                                                                      integer

                                                                                      The ID of a stage this Deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id). If omitted, the deal will be placed in the first stage of the default pipeline.

                                                                                      status

                                                                                      string

                                                                                      open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.

                                                                                      Values

                                                                                      open

                                                                                      won

                                                                                      lost

                                                                                      lost

                                                                                      deleted

                                                                                      expected_close_date

                                                                                      string

                                                                                      The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD.

                                                                                      Format

                                                                                      date

                                                                                      probability

                                                                                      number

                                                                                      Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled.

                                                                                      lost_reason

                                                                                      string

                                                                                      Optional message about why the deal was lost (to be used when status=lost)

                                                                                      visible_to

                                                                                      Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.

                                                                                      ValueDescription
                                                                                      1Owner & followers (private)
                                                                                      3Entire company (shared)

                                                                                      Values

                                                                                      1

                                                                                      3

                                                                                      Response
                                                                                      200

                                                                                      Add a Deal

                                                                                      Expand all
                                                                                      Copy code
                                                                                        • true
                                                                                        • { ... }
                                                                                          • { ... }
                                                                                            • { ... }

                                                                                            Merge two deals

                                                                                            Copy link
                                                                                            Copy to clipboard
                                                                                            PUT

                                                                                            /v1/deals/{id}/merge

                                                                                            Merges a deal with another deal. For more information on how to merge two deals, see this tutorial.

                                                                                            Path parameters

                                                                                            id

                                                                                            integer

                                                                                            required

                                                                                            ID of the deal

                                                                                            Body parameters

                                                                                            application/json

                                                                                            merge_with_id

                                                                                            integer

                                                                                            required

                                                                                            ID of the deal that the deal will be merged with

                                                                                            Response
                                                                                            200

                                                                                            Merges a Deal with another Deal.

                                                                                            Expand all
                                                                                            Copy code
                                                                                              • true
                                                                                              • { ... }

                                                                                              Update product attachment details of the deal-product (a product already attached to a deal)

                                                                                              Copy link
                                                                                              Copy to clipboard
                                                                                              PUT

                                                                                              /v1/deals/{id}/products/{product_attachment_id}

                                                                                              Updates product attachment details.

                                                                                              Path parameters

                                                                                              id

                                                                                              integer

                                                                                              required

                                                                                              ID of the deal

                                                                                              product_attachment_id

                                                                                              integer

                                                                                              required

                                                                                              ID of the deal-product (the ID of the product attached to the deal)

                                                                                              Body parameters

                                                                                              application/json

                                                                                              item_price

                                                                                              number

                                                                                              Price at which this product will be added to the deal

                                                                                              quantity

                                                                                              integer

                                                                                              Quantity – e.g. how many items of this product will be added to the deal

                                                                                              discount_percentage

                                                                                              number

                                                                                              Discount %. If omitted, will be set to 0

                                                                                              Default

                                                                                              0

                                                                                              duration

                                                                                              number

                                                                                              Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)

                                                                                              Default

                                                                                              1

                                                                                              product_variation_id

                                                                                              integer

                                                                                              ID of the product variation to use. When omitted, no variation will be used.

                                                                                              comments

                                                                                              string

                                                                                              Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.

                                                                                              enabled_flag

                                                                                              Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.

                                                                                              Values

                                                                                              0

                                                                                              1

                                                                                              Response
                                                                                              200

                                                                                              Update Product attachment details

                                                                                              Expand all
                                                                                              Copy code
                                                                                                • true
                                                                                                • { ... }

                                                                                                Delete multiple deals in bulk

                                                                                                Copy link
                                                                                                Copy to clipboard
                                                                                                DELETE

                                                                                                /v1/deals

                                                                                                Marks multiple deals as deleted.

                                                                                                Query parameters

                                                                                                ids

                                                                                                string

                                                                                                required

                                                                                                Comma-separated IDs that will be deleted

                                                                                                Response
                                                                                                200

                                                                                                Delete multiple deals in bulk

                                                                                                Expand all
                                                                                                Copy code
                                                                                                  • true
                                                                                                  • { ... }

                                                                                                  Delete a deal

                                                                                                  Copy link
                                                                                                  Copy to clipboard
                                                                                                  DELETE

                                                                                                  /v1/deals/{id}

                                                                                                  Marks a deal as deleted.

                                                                                                  Path parameters

                                                                                                  id

                                                                                                  integer

                                                                                                  required

                                                                                                  ID of the deal

                                                                                                  Response
                                                                                                  200

                                                                                                  Delete a Deal

                                                                                                  Expand all
                                                                                                  Copy code
                                                                                                    • true
                                                                                                    • { ... }

                                                                                                    Delete a follower from a deal

                                                                                                    Copy link
                                                                                                    Copy to clipboard
                                                                                                    DELETE

                                                                                                    /v1/deals/{id}/followers/{follower_id}

                                                                                                    Deletes a follower from a deal.

                                                                                                    Path parameters

                                                                                                    id

                                                                                                    integer

                                                                                                    required

                                                                                                    ID of the deal

                                                                                                    follower_id

                                                                                                    integer

                                                                                                    required

                                                                                                    ID of the follower

                                                                                                    Response
                                                                                                    200

                                                                                                    Delete a Follower from a Deal

                                                                                                    Expand all
                                                                                                    Copy code
                                                                                                      • true
                                                                                                      • { ... }

                                                                                                      Delete a participant from a deal

                                                                                                      Copy link
                                                                                                      Copy to clipboard
                                                                                                      DELETE

                                                                                                      /v1/deals/{id}/participants/{deal_participant_id}

                                                                                                      Deletes a participant from a deal.

                                                                                                      Path parameters

                                                                                                      id

                                                                                                      integer

                                                                                                      required

                                                                                                      ID of the deal

                                                                                                      deal_participant_id

                                                                                                      integer

                                                                                                      required

                                                                                                      ID of the deal participant

                                                                                                      Response
                                                                                                      200

                                                                                                      Delete a Participant from a Deal

                                                                                                      Expand all
                                                                                                      Copy code
                                                                                                        • true
                                                                                                        • { ... }

                                                                                                        Delete an attached product from a deal

                                                                                                        Copy link
                                                                                                        Copy to clipboard
                                                                                                        DELETE

                                                                                                        /v1/deals/{id}/products/{product_attachment_id}

                                                                                                        Deletes a product attachment from a deal, using the product_attachment_id.

                                                                                                        Path parameters

                                                                                                        id

                                                                                                        integer

                                                                                                        required

                                                                                                        ID of the deal

                                                                                                        product_attachment_id

                                                                                                        integer

                                                                                                        required

                                                                                                        Product attachment ID. This is returned as product_attachment_id after attaching a product to a deal or as id when listing the products attached to a deal.

                                                                                                        Response
                                                                                                        200

                                                                                                        Delete an attached Product from a Deal

                                                                                                        Expand all
                                                                                                        Copy code
                                                                                                          • true
                                                                                                          • { ... }

                                                                                                          Subscribe to Pipedrive’s Developer Newsletter