POST
Create Followup

Overview

This endpoint allows you to create a new followup activity for an existing debt. You can log calls, emails, SMS, or other communication activities.

Authentication

Requires a valid OAuth 2.0 access token with the followups:write scope.

Request

string
required
Bearer token for authentication
string
required
Must be application/json

Request Body

string
required
Encrypted ID of the debt this followup belongs to
string
Type of followup: call, email, sms, whatsapp, voicemail, manual_call, physical, postmail
string
Followup status. Use simple string values: on_hold, scheduled, in_progress, sent, delivered, deal_found, no_answer, deal_not_found, bad_behavior, failed, cancelled. Defaults to on_hold.
string
When the followup was executed (ISO 8601 format)
string
When to execute the followup (ISO 8601 format)
string
Brief summary of the followup
string
Detailed notes about the followup
string
External call ID from the provider
string
URL to the call recording
integer
Duration in milliseconds (for calls)
string
Phone number used for the followup
string
Call direction: inbound or outbound
string
Reason for call disconnection
boolean
Whether this is a retry attempt

Example Request

Response

boolean
Always false for successful requests
string
Success message
object
The created followup object

Success Response

Validation Rules

  • debt_id: Must be a valid encrypted debt ID that belongs to your company
  • type: Must be one of: call, sms, email, whatsapp, voicemail, manual_call, physical, postmail
  • status: Must be one of: on_hold, scheduled, in_progress, sent, delivered, deal_found, no_answer, deal_not_found, bad_behavior, failed, cancelled
  • Default is on_hold if not specified
  • scheduled_at: Must be in ISO 8601 format if provided
  • call_date: Must be in ISO 8601 format if provided

Error Responses

After Creation

Once a followup is created, you can:
  1. Monitor Progress: Use Get Followup to check status
  2. Update Details: Use Update Followup to modify information
  3. Track Results: View completion status and outcomes
  4. Generate Reports: Include followup data in your analytics