API Reference / Predefined Actions

GET /predefined_actions

Get the list of predefined actions (for the logged API user's account)

Returns the account's predefined actions — reusable next-action templates, each with the text to apply and a days offset used to calculate the due date. Actions that belong to a group are included, and carry that group's action_group_id.

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • predefined_actionsarray<object>
      array item fields →
      • predefined_actionobject

        Template actions users may use frequently in their sales process. Referred to as 'Saved Actions' in the web application.

        object fields →
        • idstringbson-id

          ID of the predefined action

        • textstringrequired

          Description text of the predefined action

        • daysintegerint32required

          Suggested number of days until the action becomes due

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides