API Reference / Predefined Actions

POST /predefined_actions

Create a new predefined action

Creates a predefined action template. text (max 140 characters) and days are required; text can embed placeholders like [first name] that are substituted when the action is applied to a contact.

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

201 Created
  • 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