LlamadaPro API (1.0.0)

List tasks with support for filtering, sorting, and pagination.

Returns a paginated list of tasks. Supports filtering by status, due dates, conversation, assignee, and other criteria.

Example usage: GET /api/v1/tasks?status=pending&limit=20&pageToken=Xde34567890

Create a new task.

Creates a new task with the specified details. Tasks can be assigned to users and can include due dates, descriptions, and other metadata.

Example usage: POST /api/v1/tasks { "title": "Follow up with client", "objective": "Send proposal to client", "dueDate": "2024-02-15T10:00:00Z", "assignedTo": { "type": "user", "id": "123" } }

Get a task by ID.

Retrieves a single task by its unique identifier, including all task details and assignment information.

Update an existing task.

Updates the details of an existing task. Only fields provided in the request body will be updated. This includes status changes, assignment updates, due date modifications, etc.

Example usage: PUT /api/v1/tasks/task_123 { "status": "completed", "objective": "Updated task objective" }

Delete a task by ID.

Permanently deletes a task and all associated data. This action cannot be undone.

Create multiple conversations in a single request.

This endpoint allows you to create multiple conversations at once. Each conversation in the batch will be validated before processing. The response includes details about any validation issues encountered during processing.

If some conversations fail validation, the valid ones will still be processed.

Update multiple conversations in a single request.

This endpoint allows you to update multiple existing conversations at once. Each conversation update in the batch will be validated before processing. The response includes details about any validation issues encountered during processing.

You must provide the ID for each conversation you want to update. If some conversations fail validation, the valid ones will still be processed.

Create a single conversation.

This endpoint allows you to create a single conversation and returns the created conversation immediately with all associated data including contact information.

Use this endpoint when you need the created conversation immediately for subsequent operations.

Either contactId or contact information must be provided. If contact is provided, a new contact will be created or an existing contact will be matched based on the addresses and updated.

List contacts with support for filtering, sorting, and pagination.

Returns a paginated list of contacts. Supports basic filtering, sorting and pagination via query parameters.

Note: The phone and email fields on the Contact object are legacy and will be removed in the future. Use the addresses array for all phone numbers and email addresses.

Example usage: GET /api/v1/contacts?filterBy=firstName:John;email:john@example.com&sortBy=createdAt=desc&pageSize=20&pageToken=Xde34567890

Create a new contact.

Creates a new contact. Custom fields and addresses can be included in the request body.

Note: The phone and email fields on the Contact object are legacy and will be removed in the future. Use the addresses array for all phone numbers and email addresses.

Example usage: POST /api/v1/contacts { "firstName": "Jane", "lastName": "Doe", "customFields": { "source": "web" }, "addresses": [ { "address": "+56912345678", "channelType": "PHONE" } ] }

Get a contact by ID.

Retrieves a single contact by its unique identifier, including all custom fields and addresses.

Note: The phone and email fields on the Contact object are legacy and will be removed in the future. Use the addresses array for all phone numbers and email addresses.

Update an existing contact.

Updates the details of an existing contact, including custom fields and addresses. Only fields provided in the request body will be updated.

Note: The phone and email fields on the Contact object are legacy and will be removed in the future. Use the addresses array for all phone numbers and email addresses.

Example usage: PUT /api/v1/contacts/123 { "firstName": "Janet", "customFields": { "priority": "high" } }

Delete a contact by ID.

Permanently deletes a contact and all associated custom fields and addresses.

Search contacts using advanced querying, sorting, search and pagination.

Performs a full search across all contacts. Supports advanced search parameters, sorting and pagination.

Note:

• This endpoint may be rate limited to ensure system stability.
• The phone and email fields on the Contact object are legacy and may be removed in the future. Use the addresses array for all phone numbers and email addresses.

Example usage: POST /api/v1/contacts/search { "filters": [ { "field": "addresses.address", "operator": "eq", "value": "+56912345678" }, { "field": "addresses.address", "operator": "contains", "value": "example.com" } ], "sort": [ { "field": "createdAt", "direction": "desc" } ], "size": 20, "pageToken": "Xde34567890", "includeTotalCount": "true" }

Get a message by ID.

This endpoint allows you to retrieve a specific message using its unique identifier. The response includes all message details including content, sender/recipient info, signed attachments, and metadata.