Update Followup

{
  "error": false,
  "message": "Followup updated successfully",
  "data": {
    "id": "abc123def456",
    "debt_id": "xyz789ghi012",
    "status": "deal_found",
    "type": "call",
    "call_date": "2024-01-25T10:15:00+00:00",
    "scheduled_at": "2024-01-25T10:00:00+00:00",
    "summary": "Successful contact, payment plan agreed",
    "notes": "Customer agreed to pay €500 monthly starting February 1st.",
    "call_id": "call_789456",
    "audio_url": "https://s3.amazonaws.com/bucket/recordings/call_789456.mp3?X-Amz-Signature=...",
    "pdf_url": null,
    "duration_ms": 240000,
    "disconnection_reason": "completed_successfully",
    "direction": "outbound",
    "phone_number_used": "+33800123456",
    "is_retry": false,
    "processed_at": "2024-01-25T10:20:00+00:00",
    "media_urls_expire_at": "2024-01-25T11:20:00+00:00"
  }
}

Overview

This endpoint allows you to update information for an existing followup. You can modify status, add results, update notes, and record completion details. Note that the debt_id cannot be changed.

Authentication

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

Example Request

curl -X PUT "/external-api/v1/followups/abc123def456" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "deal_found",
    "call_date": "2024-01-25T10:15:00Z",
    "duration_ms": 240000,
    "summary": "Successful contact, payment plan agreed",
    "notes": "Customer agreed to pay €500 monthly starting February 1st."
  }'

const followupId = 'abc123def456';
const updateData = {
  status: 'deal_found',
  call_date: '2024-01-25T10:15:00Z',
  duration_ms: 240000,
  summary: 'Successful contact, payment plan agreed',
  notes: 'Customer agreed to pay €500 monthly starting February 1st.'
};

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

const result = await response.json();

Success Response

{
  "error": false,
  "message": "Followup updated successfully",
  "data": {
    "id": "abc123def456",
    "debt_id": "xyz789ghi012",
    "status": "deal_found",
    "type": "call",
    "call_date": "2024-01-25T10:15:00+00:00",
    "scheduled_at": "2024-01-25T10:00:00+00:00",
    "summary": "Successful contact, payment plan agreed",
    "notes": "Customer agreed to pay €500 monthly starting February 1st.",
    "call_id": "call_789456",
    "audio_url": "https://s3.amazonaws.com/bucket/recordings/call_789456.mp3?X-Amz-Signature=...",
    "pdf_url": null,
    "duration_ms": 240000,
    "disconnection_reason": "completed_successfully",
    "direction": "outbound",
    "phone_number_used": "+33800123456",
    "is_retry": false,
    "processed_at": "2024-01-25T10:20:00+00:00",
    "media_urls_expire_at": "2024-01-25T11:20:00+00:00"
  }
}

Common Update Scenarios

Mark as Deal Found

{
  "status": "deal_found",
  "call_date": "2024-01-25T10:15:00Z",
  "summary": "Customer contacted successfully, agreement reached"
}

Mark as Delivered (for messages)

{
  "status": "delivered",
  "call_date": "2024-01-25T10:15:00Z",
  "summary": "Message delivered to recipient"
}

Record Failed Attempt

{
  "status": "no_answer",
  "call_date": "2024-01-25T10:15:00Z",
  "summary": "No answer after multiple attempts",
  "notes": "Phone rang but no answer. Will try again tomorrow."
}

Add Call Results

{
  "status": "deal_found",
  "duration_ms": 180000,
  "summary": "Payment discussion",
  "notes": "Customer acknowledged debt and requested payment plan options"
}

Cancel Followup

{
  "status": "cancelled",
  "notes": "Customer paid in full before followup was executed"
}

Validation Rules

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

Type Validation

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

Date Validation

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

Error Responses

{
  "error": true,
  "message": "Invalid JSON payload",
  "code": 400
}

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

{
  "error": true,
  "message": "Followup not found or invalid ID",
  "code": 404
}

Get Followup - Get specific followup details
List Followups - Get all followups
Create Followup - Create a new followup

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

Common Update Scenarios

Mark as Deal Found

Mark as Delivered (for messages)

Record Failed Attempt

Add Call Results

Cancel Followup

Validation Rules

Error Responses

​Overview

​Authentication

​Example Request

​Success Response

​Common Update Scenarios

​Mark as Deal Found

​Mark as Delivered (for messages)

​Record Failed Attempt

​Add Call Results

​Cancel Followup

​Validation Rules

​Error Responses

​Related Endpoints

Overview

Authentication

Example Request

Success Response

Common Update Scenarios

Mark as Deal Found

Mark as Delivered (for messages)

Record Failed Attempt

Add Call Results

Cancel Followup

Validation Rules

Error Responses

Related Endpoints