Buyer Blast API Documentation

Send SMS and email blast notifications to buyer contacts using GoHighLevel. The API handles message formatting, address masking, and delivery tracking.

Send Buyer Blast

Request Data

Custom Data

Request Preview

Method: POST

URL: /api/v1/{locationId}/buyers/blast

Headers:

{
  "Content-Type": "application/json",
  "m4-connect-key": "[your-api-key]"
}

Body:

API Reference

Authentication

m4-connect-key

Required header. API key configured in M4 Connect or local shared token.

Request Types

sms_buyer_blast

Send SMS notification to buyer contacts about properties

email_buyer_blast

Send email notification to buyer contacts about properties

Request Fields

id

string (required) - Opportunity ID from GoHighLevel

contact_id

string (required) - Contact ID from GoHighLevel

customData.jobId

string (optional) - Job tracking ID

customData.dealAddress

string (optional) - Property address (street number will be masked)

customData.message

string (required) - Message body. Use \n for line breaks.

Message Processing

Escaped Newline Replacement

Escaped newlines (\n) in the message are automatically replaced with actual line breaks

Address Masking

Street numbers are automatically masked: single digits become #, multi-digit become first digit + #s

Error Responses

400 Bad Request

Missing required fields or invalid request format

401 Unauthorized

Invalid or missing m4-connect-key header, or API key not authorized for this location

429 Too Many Requests

Rate limit exceeded. Retry after the specified interval.

500 Server Error

Internal server error while processing request

Success Response Example

{
  "success": true,
  "jobId": "job-789",
  "contactId": "contact-456",
  "opportunityId": "opp-123",
  "message": "Buyer blast message queued for delivery",
  "status": "PENDING",
  "createdAt": "2024-07-06T12:34:56Z"
}