Skip to content

API Reference / Predefined Action Groups

POST /predefined_action_groups

Create a new predefined action group

Creates a predefined action group. text is required and action_ids must list at least two existing, currently ungrouped predefined actions. Names longer than 127 characters are truncated on save.

Maintained by the OnePageCRM engineering team

Request body

  • textstring

    Name of the predefined action group

  • positionintegerint32

    Position of the group in the list of predefined action groups

  • action_idsarray<string>

    List of IDs of the predefined actions in the predefined action group

Responses

201 Created
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • predefined_action_groupobject

      A grouping of predefined actions. Useful if actions can be assigned together as part of a workflow.

      object fields →
      • idstringbson-id

        ID of the predefined action group

      • textstring

        Name of the predefined action group

      • positionintegerint32

        Position of the group in the list of predefined action groups

      • action_idsarray<string>

        List of IDs of the predefined actions in the predefined action group

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

Related guides