API Reference / Predefined Actions

PUT /predefined_actions/{predefined_action_id}

Update a specific predefined action

Updates a predefined action template's text (max 140 characters), days offset or position — but not its group membership, which is silently ignored if you send action_group_id. Use the groups endpoint to move an action between groups.

Path parameters

Name Type Description
predefined_action_id req string Predefined Action ID

Request body

  • idstringbson-id

    ID of the predefined action

  • textstringrequired

    Description text of the predefined action

  • daysintegerint32required

    Suggested number of days until the action becomes due

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