Skip to main content
POST
/
contacts
/
fulfill
curl -X POST https://api.guayaba.ai/contacts/fulfill \
  -H "Content-Type: application/json" \
  -H "X-API-Key: gua_a1b2c3d4_your-api-key-here" \
  -d '{
    "phone": "+11234567890"
  }'
{
  "success": true,
  "message": "Contact marked as fulfilled successfully"
}
Marks a contact as fulfilled by their phone number. This cancels all scheduled outreach (calls, SMS, WhatsApp messages, and triggers) and sets the contact’s status to fulfilled.
This endpoint requires an X-API-Key header. See Authentication for details.

Request Body

phone
string
required
Phone number of the contact to fulfill, in E.164 format (e.g., +11234567890).

Behavior Notes

All pending calls, SMS, WhatsApp messages, and triggers for this contact are immediately cancelled.
The contact’s status is set to fulfilled and the fulfilledAt timestamp is recorded automatically.

Response

success
boolean
Always true on a successful request.
message
string
Human-readable confirmation message.
curl -X POST https://api.guayaba.ai/contacts/fulfill \
  -H "Content-Type: application/json" \
  -H "X-API-Key: gua_a1b2c3d4_your-api-key-here" \
  -d '{
    "phone": "+11234567890"
  }'
{
  "success": true,
  "message": "Contact marked as fulfilled successfully"
}