Skip to content

Accounts

briansemify edited this page Oct 20, 2025 · 3 revisions

Accounts — Create & Attributes

Create Account

  • Endpoint: POST /api/v2/accounts
  • Required fields:
    • account_name, phone, email, first_name, last_name
    • address_1, city, state, postal, country, website_url
    • external_account_identifier
  • Optional: address_2, external_account_manager, external_campaign_manager, attributes

Example request:

{
  "account_name": "Acme Business Solutions",
  "phone": "555-123-4567",
  "email": "contact@acmebusiness.com",
  "first_name": "John",
  "last_name": "Smith",
  "address_1": "123 Main Street",
  "city": "Anytown",
  "state": "CA",
  "postal": "90210",
  "country": "US",
  "website_url": "https://www.acmebusiness.com",
  "external_account_identifier": "ACME-001"
}

Sample response:

{
  "data": { "campaign_id": "476273", "account_id": "424685" },
  "messages": ["Account successfully created."],
  "error": false
}

Custom attributes

  • Use attributes to attach arbitrary metadata:
"attributes": [
  { "field_name": "Industry", "field_value": "Technology" },
  { "field_name": "Priority Level", "field_value": "High" }
]

Recommendations

  • Use external_account_identifier to store your system's unique account ID.
  • Keep attribute names consistent across integrations.

Clone this wiki locally