Contents

Guide

Conventions

Paths, methods, bodies, ids and dates.

  • Base address: https://engage.growthdept.ai/api. Operations live under /fb/page, /fb/subscriber, /fb/sending and /user/template.
  • Methods: reads are GET with query parameters; changes are POST with a JSON body (form-encoded bodies are accepted too). Bodies are capped at 1 MB.
  • Envelope: successful answers are {"status": "success", "data": ...}, or {"status": "success"} when there's nothing to return.
  • Ids: contacts, tags, fields and growth tools have integer ids. Flows are identified by their ns string. Instagram and other large platform ids are written as plain numbers.
  • Contacts are called subscribers in paths and fields, for compatibility.
  • Values a contact lacks come back as null.
  • Dates are ISO 8601 strings.

Next: Rate limits