Sign in
automations

Create a DM automation

Creates a DM automation: when its trigger fires it sends one direct message (text plus up to 3 link buttons). Set followGate (Instagram only) to gate that message behind a follow check, and emailGate to gate it behind the contact replying with an email address. Set webhook to call an external endpoint once the message is sent; its payload carries the run's contact and identifiers.

post/v2/dm-automations

Request body

accountIdstring required
dmMessagestring required
isActiveboolean
namestring required
platform'facebook' | 'instagram' required

Response

Default Response

Changes

Changed in 2 of the 8 revisions of this API.12

  • 39e94457ccb26See the full diff
    • ○

      added the optional property action to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property action to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property action to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property details to the response with the 500 status

      response-optional-property-added

  • d6a97ae30ca56See the full diff
    • ○

      added the new optional request property emailGate

      new-optional-request-property

    • ○

      added the new optional request property followGate

      new-optional-request-property

    • ○

      added the new optional request property webhook

      new-optional-request-property

    • ○

      added the optional property flow/emailGate to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property flow/followGate to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property flow/webhook to the response with the 201 status

      response-optional-property-added