Call Requests API - Venddor API

Call Requests Endpoints

The Call Requests API allows you to manage customer callback requests in the Venddor platform. This documentation outlines the available endpoints and their supported HTTP methods.

Base URL: https://www.venddor.com.br/api/2.0

Available Endpoints

GET POST /call_requests/

This endpoint allows you to retrieve all call requests or create a new call request.

Supported Methods

Method Description Usage
GET Retrieve all call requests Use pagination parameters to limit results. See Pagination section for details.
POST Create a new call request Requires a JSON body with call request details.
Request Example
Response Example
{
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "notes": "Customer is interested in our Enterprise plan",
  "priority": "high",
  "assignee_id": 42
}
{
  "id": 12345,
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "created_at": "2025-04-16T10:25:32Z",
  "notes": "Customer is interested in our Enterprise plan",
  "status": "pending",
  "priority": "high",
  "assignee_id": 42
}
GET PUT DELETE /call_requests/:id

This endpoint allows you to work with a specific call request identified by its ID.

Path Parameters

Parameter Type Description
id* integer The unique identifier of the call request

Supported Methods

Method Description Usage
GET Retrieve a specific call request Returns detailed information about the specified call request
PUT Update a call request Requires a JSON body with fields to update
DELETE Delete a call request Permanently removes the call request from the system
Update Example
Response Example
{
  "status": "completed",
  "notes": "Customer was contacted and purchased the Enterprise plan",
  "completed_at": "2025-04-17T15:45:22Z"
}
{
  "id": 12345,
  "phone": "+5511999998888",
  "name": "João Silva",
  "request_time": "2025-04-17T14:30:00Z",
  "created_at": "2025-04-16T10:25:32Z",
  "updated_at": "2025-04-17T15:45:22Z",
  "notes": "Customer was contacted and purchased the Enterprise plan",
  "status": "completed",
  "priority": "high",
  "assignee_id": 42,
  "completed_at": "2025-04-17T15:45:22Z"
}
Tip: When updating call requests, you only need to include the fields that have changed. The system will preserve any fields not included in your request.

Status Codes

Status Code Description
200 OK Request successful (for GET and PUT requests)
201 Created Resource created successfully (for POST requests)
204 No Content Resource deleted successfully (for DELETE requests)
400 Bad Request Invalid request parameters
401 Unauthorized Authentication failed or not provided
403 Forbidden You don't have permission to access the resource
404 Not Found The requested resource does not exist
500 Internal Server Error An error occurred on the server
Copyright © . Venddor Tecnologia S.A. All rights reserved.