scheduledMessages

List first messages and where each stands

Changed on

List messages with optional filters by status, contact, or campaign. Valid status values: draft | sending | sent | failed | cancelled. The status filter is exact: scheduled rows are legacy first messages or approved connection requests. Each row carries firstDm, where that person's first message stands. Do NOT pass outreachStatus values (like 'replied') here.

get/scheduled-messages

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/scheduled-messages
  • Auth: HTTP bearer

Query parameters

status'draft' | 'scheduled' | 'sending' | 'sent' | 'failed' | 'cancelled'
contactIdstring
campaignSlugstring
limitinteger
offsetinteger

Response

Messages list

successtrue required
totalinteger required
limitinteger required
offsetinteger required
creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes

  • bdaed6984b20Revision changes
    • warning

      removed the optional property from the response with the status

  • e8a9550eb535Revision changes
    • warning

      added the new window enum value to the /// response property for the response status

    • info

      added the required property /// to the response with the status