ActivityTypes

Activity types represent different kinds of activities that can be stored. Each activity type is presented to the user with an icon and a name. Additionally, a color can be defined (not implemented in the Pipedrive app as of today). Activity types are linked to activities via ActivityType.key_string = Activity.type. The key_string will be generated by the API based on the given name of the activity type upon creation, and cannot be changed. Activity types should be presented to the user in an ordered manner, using the ActivityType.order_nr value.

Get all activity types

Copy link
Copy to clipboard
GET

/v1/activityTypes

Returns all activity types.

Response
200

OK

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

    Add new activity type

    Copy link
    Copy to clipboard
    POST

    /v1/activityTypes

    Adds a new activity type.

    Body parameters

    application/x-www-form-urlencoded

    name

    string

    required

    The name of the activity type

    icon_key

    string

    required

    Icon graphic to use for representing this activity type

    Values

    task

    email

    meeting

    deadline

    call

    lunch

    calendar

    downarrow

    document

    smartphone

    camera

    scissors

    cogs

    bubble

    uparrow

    checkbox

    signpost

    shuffle

    addressbook

    linegraph

    picture

    car

    world

    search

    clip

    sound

    brush

    key

    padlock

    pricetag

    suitcase

    finish

    plane

    loop

    wifi

    truck

    cart

    bulb

    bell

    presentation

    color

    string

    A designated color for the activity type in 6-character HEX format (e.g. FFFFFF for white, 000000 for black)

    Response
    200

    OK

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

      Update an activity type

      Copy link
      Copy to clipboard
      PUT

      /v1/activityTypes/{id}

      Updates an activity type.

      Path parameters

      id

      integer

      required

      The ID of the activity type

      Body parameters

      application/x-www-form-urlencoded

      name

      string

      The name of the activity type

      icon_key

      string

      Icon graphic to use for representing this activity type

      Values

      task

      email

      meeting

      deadline

      call

      lunch

      calendar

      downarrow

      document

      smartphone

      camera

      scissors

      cogs

      bubble

      uparrow

      checkbox

      signpost

      shuffle

      addressbook

      linegraph

      picture

      car

      world

      search

      clip

      sound

      brush

      key

      padlock

      pricetag

      suitcase

      finish

      plane

      loop

      wifi

      truck

      cart

      bulb

      bell

      presentation

      color

      string

      A designated color for the activity type in 6-character HEX format (e.g. FFFFFF for white, 000000 for black)

      order_nr

      integer

      An order number for this activity type. Order numbers should be used to order the types in the activity type selections.

      Response
      200

      OK

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

        Delete multiple activity types in bulk

        Copy link
        Copy to clipboard
        DELETE

        /v1/activityTypes

        Marks multiple activity types as deleted.

        Query parameters

        ids

        string

        required

        The comma-separated activity type IDs

        Response
        200

        OK

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

          Delete an activity type

          Copy link
          Copy to clipboard
          DELETE

          /v1/activityTypes/{id}

          Marks an activity type as deleted.

          Path parameters

          id

          integer

          required

          The ID of the activity type

          Response
          200

          OK

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

            Subscribe to Pipedrive’s Developer Newsletter