Create Followup

{
  "error": false,
  "message": "Followup created successfully",
  "data": {
    "id": "abc123def456",
    "debt_id": "xyz789ghi012",
    "status": "scheduled",
    "type": "call",
    "call_date": null,
    "scheduled_at": "2024-01-25T10:00:00+00:00",
    "summary": "Follow-up call to discuss payment plan",
    "notes": "Customer previously expressed interest in monthly payment schedule",
    "call_id": null,
    "audio_url": null,
    "pdf_url": null,
    "duration_ms": null,
    "disconnection_reason": null,
    "direction": null,
    "phone_number_used": null,
    "is_retry": false,
    "processed_at": "2024-01-22T15:30:00+00:00"
  }
}

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.

Example Request

curl -X POST "/external-api/v1/followups" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "debt_id": "xyz789ghi012",
    "type": "call",
    "status": "scheduled",
    "scheduled_at": "2024-01-25T10:00:00Z",
    "summary": "Follow-up call to discuss payment plan",
    "notes": "Customer previously expressed interest in monthly payment schedule"
  }'

const followupData = {
  debt_id: 'xyz789ghi012',
  type: 'call',
  status: 'scheduled',
  scheduled_at: '2024-01-25T10:00:00Z',
  summary: 'Follow-up call to discuss payment plan',
  notes: 'Customer previously expressed interest in monthly payment schedule'
};

const response = await fetch('/external-api/v1/followups', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(followupData)
});

const result = await response.json();

Success Response

{
  "error": false,
  "message": "Followup created successfully",
  "data": {
    "id": "abc123def456",
    "debt_id": "xyz789ghi012",
    "status": "scheduled",
    "type": "call",
    "call_date": null,
    "scheduled_at": "2024-01-25T10:00:00+00:00",
    "summary": "Follow-up call to discuss payment plan",
    "notes": "Customer previously expressed interest in monthly payment schedule",
    "call_id": null,
    "audio_url": null,
    "pdf_url": null,
    "duration_ms": null,
    "disconnection_reason": null,
    "direction": null,
    "phone_number_used": null,
    "is_retry": false,
    "processed_at": "2024-01-22T15:30:00+00:00"
  }
}

Validation Rules

Required Fields

debt_id: Must be a valid encrypted debt ID that belongs to your company

Type Validation

type: Must be one of: call, sms, email, whatsapp, voicemail, manual_call, physical, postmail

Status Validation

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

Date Validation

scheduled_at: Must be in ISO 8601 format if provided
call_date: Must be in ISO 8601 format if provided

Error Responses

{
  "error": true,
  "message": "Validation failed",
  "code": 400,
  "details": {
    "debt_id": "Debt ID is required",
    "type": "Invalid followup type. Valid types are: call, sms, email, whatsapp, voicemail, manual_call, physical, postmail"
  }
}

{
  "error": true,
  "message": "Access denied to this debt",
  "code": 403
}

{
  "error": true,
  "message": "Debt not found",
  "code": 404
}

After Creation

Once a followup is created, you can:

Monitor Progress: Use Get Followup to check status
Update Details: Use Update Followup to modify information
Track Results: View completion status and outcomes
Generate Reports: Include followup data in your analytics

List Followups - Get all followups
Get Followup - Get specific followup details
Update Followup - Modify followup information
Get Debt - Get the associated debt information

Get started

Guides

SFTP integration

Company API

Creditors API

Debtors API

Debts API

Timelines API

Campaigns API

Settings API

Invoice documents API

Followups API

Todos API

Status API

Overview

Authentication

Example Request

Success Response

Validation Rules

Error Responses

After Creation

​Overview

​Authentication

​Example Request

​Success Response

​Validation Rules

​Error Responses

​After Creation

​Related Endpoints

Overview

Authentication

Example Request

Success Response

Validation Rules

Error Responses

After Creation

Related Endpoints