Update Callout

Update callout details including scheduling and configuration

Update Callout

Update specific details of a callout including scheduling, actions, and configuration.

Only certain fields can be updated depending on the callout status. Active callouts have limited update capabilities.

Request

id · string · required

The unique identifier of the callout to update

scheduled_time · string

ISO 8601 timestamp for when to execute the callout

actions · object

Configuration for callout actions

priority · string

Priority level of the callout (low, medium, high, urgent)

target_contact · object

Updated contact information for the callout target

metadata · object

Additional metadata for the callout

Authorization · string · required

Bearer token for API authentication

cURL

curl --request PUT \
     --url https://api.credira.com/v1/callouts/callout_123456789 \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/json' \
     --data '{
       "scheduled_time": "2024-01-25T14:00:00Z",
       "actions": {
         "calls_enabled": true,
         "emails_enabled": true,
         "voice_agent_id": "agent_789123456"
       },
       "priority": "high",
       "target_contact": {
         "name": "Jane Smith",
         "email": "[e-mail]",
         "phone": "[phone]"
       },
       "metadata": {
         "campaign_id": "camp_456",
         "department": "sales",
         "notes": "Updated contact information"
       }
     }'

Response

{
  "success": true,
  "data": {
    "id": "callout_123456789",
    "invoice_id": "inv_987654321",
    "status": "scheduled",
    "type": "payment_reminder",
    "scheduled_time": "2024-01-25T14:00:00Z",
    "created_time": "2024-01-19T09:00:00Z",
    "updated_time": "2024-01-15T10:30:00Z",
    "target_contact": {
      "name": "Jane Smith",
      "email": "[e-mail]",
      "phone": "[phone]"
    },
    "actions": {
      "calls_enabled": true,
      "emails_enabled": true,
      "voice_agent_id": "agent_789123456"
    },
    "account_id": "acc_789123456",
    "priority": "high",
    "metadata": {
      "campaign_id": "camp_456",
      "department": "sales",
      "notes": "Updated contact information"
    }
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789",
    "message": "Callout updated successfully"
  }
}

Response

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request data"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

Response

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

Response

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "You don't have permission to update this callout"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

Response

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Callout not found"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

Response

{
  "success": false,
  "error": {
    "code": "CONFLICT",
    "message": "Cannot update callout that is currently active"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}