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": "jane.smith@example.com",
"phone": "+1987654321"
},
"metadata": {
"campaign_id": "camp_456",
"department": "sales",
"notes": "Updated contact information"
}
}'
const calloutId = "callout_123456789";
const response = await fetch(
`https://api.credira.com/v1/callouts/${calloutId}`,
{
method: "PUT",
headers: {
Authorization: "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
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: "jane.smith@example.com",
phone: "+1987654321",
},
metadata: {
campaign_id: "camp_456",
department: "sales",
notes: "Updated contact information",
},
}),
}
);
const data = await response.json();
console.log(data);
{
"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": "jane.smith@example.com",
"phone": "+1987654321"
},
"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"
}
}
Call outs
Update Callout
Update callout details including scheduling and configuration
PUT
/
callouts
/
{id}
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": "jane.smith@example.com",
"phone": "+1987654321"
},
"metadata": {
"campaign_id": "camp_456",
"department": "sales",
"notes": "Updated contact information"
}
}'
const calloutId = "callout_123456789";
const response = await fetch(
`https://api.credira.com/v1/callouts/${calloutId}`,
{
method: "PUT",
headers: {
Authorization: "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
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: "jane.smith@example.com",
phone: "+1987654321",
},
metadata: {
campaign_id: "camp_456",
department: "sales",
notes: "Updated contact information",
},
}),
}
);
const data = await response.json();
console.log(data);
{
"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": "jane.smith@example.com",
"phone": "+1987654321"
},
"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"
}
}
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
string
required
The unique identifier of the callout to update
string
ISO 8601 timestamp for when to execute the callout
object
Configuration for callout actions
string
Priority level of the callout (low, medium, high, urgent)
object
Updated contact information for the callout target
object
Additional metadata for the callout
string
required
Bearer token for API authentication
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": "jane.smith@example.com",
"phone": "+1987654321"
},
"metadata": {
"campaign_id": "camp_456",
"department": "sales",
"notes": "Updated contact information"
}
}'
const calloutId = "callout_123456789";
const response = await fetch(
`https://api.credira.com/v1/callouts/${calloutId}`,
{
method: "PUT",
headers: {
Authorization: "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
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: "jane.smith@example.com",
phone: "+1987654321",
},
metadata: {
campaign_id: "camp_456",
department: "sales",
notes: "Updated contact information",
},
}),
}
);
const data = await response.json();
console.log(data);
{
"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": "jane.smith@example.com",
"phone": "+1987654321"
},
"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"
}
}
{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "Invalid request data"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"request_id": "req_123456789"
}
}
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"request_id": "req_123456789"
}
}
{
"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"
}
}
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Callout not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"request_id": "req_123456789"
}
}
{
"success": false,
"error": {
"code": "CONFLICT",
"message": "Cannot update callout that is currently active"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"request_id": "req_123456789"
}
}