Skip to content

API Reference / Predefined Actions

GET /predefined_actions/{predefined_action_id}

Get a specific predefined action

Returns one predefined action template, including its text, days offset and the action_group_id of the group it belongs to. Passing a group's ID here returns not-found — use the predefined action groups endpoint for those.

Maintained by the OnePageCRM engineering team

Path parameters

Name Type Description
predefined_action_id req string Predefined Action ID

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object 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