LeadLabels

Lead labels allow you to visually categorize your leads. There are three default lead labels: hot, cold, and warm, but you can add as many new custom labels as you want.

Get all lead labels

Copy link
Copy to clipboard
GET

/v1/leadLabels

Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.

Response
200

OK

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

    Add a lead label

    Copy link
    Copy to clipboard
    POST

    /v1/leadLabels

    Creates a lead label.

    Body parameters

    application/json

    name

    string

    required

    The name of the lead label

    color

    string

    required

    The color of the label. Only a subset of colors can be used.

    Values

    green

    blue

    red

    yellow

    purple

    gray

    Response
    200

    OK

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

      Delete a lead label

      Copy link
      Copy to clipboard
      DELETE

      /v1/leadLabels/{id}

      Deletes a specific lead label.

      Path parameters

      id

      string

      required

      The ID of the lead label

      Format

      uuid

      Response
      200

      OK

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

        Update a lead label

        Copy link
        Copy to clipboard
        PATCH

        /v1/leadLabels/{id}

        Updates one or more properties of a lead label. Only properties included in the request will be updated.

        Path parameters

        id

        string

        required

        The ID of the lead label

        Format

        uuid

        Body parameters

        application/json

        name

        string

        The name of the lead label

        color

        string

        The color of the label. Only a subset of colors can be used.

        Values

        green

        blue

        red

        yellow

        purple

        gray

        Response
        200

        OK

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

          Subscribe to Pipedrive’s Developer Newsletter