Skip to content
Pinlyx Docs
Quickstart
Guides
API
MCP
Webhooks
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Open app
Start here
Introduction
Quickstart
Authentication
Errors & rate limits
Guides
Sync contacts
Send a Telegram message
Integrations
MCP server
Webhooks
ikas
Shopify
WooCommerce
API Reference
Overview
Authentication
Overview
Get current workspace identity
GET
Account
Overview
Get current workspace identity
GET
Contacts
Overview
List contacts
GET
Create a contact
POST
Bulk create or update contacts
POST
Get a contact by id
GET
Delete a contact
DELETE
Update a contact
PATCH
List the tag dictionary
GET
List a contact's tags
GET
Attach a tag to a contact
POST
Detach a tag from a contact
DELETE
Set a contact's lead score
PUT
Assign a contact to a team member
PUT
List the custom field schema
GET
Read a contact's custom field values
GET
Merge custom field values into a contact
PUT
Get a contact's activity timeline
GET
Add a note to a contact's timeline
POST
Messages
Overview
Enqueue a Telegram outbound message
POST
Get a message job by id
GET
Deals
Overview
List deals
GET
Create a deal
POST
Get a deal by id
GET
Change a deal's stage
POST
Tasks
Overview
List tasks
GET
Create a task
POST
Get a task by id
GET
Change a task's status
POST
Finance
Overview
Finance summary
GET
List finance transactions
GET
List invoices
GET
List revenue sources
GET
Email
Overview
List email inbox threads
GET
Get an email thread with messages
GET
Set an email thread's status
POST
Assign an email thread
POST
Social inbox
Overview
List connected social accounts
GET
List social DM conversations
GET
Get a social conversation
GET
List messages in a conversation
GET
Send a DM
POST
Mark a conversation read
POST
Social inbox summary
GET
Social posts
Overview
List social posts
GET
Schedule a post
POST
Publishing stats
GET
Get a post by id
GET
Delete a post record
DELETE
Edit a scheduled post
PATCH
Cancel a scheduled post
POST
Help
FAQ
Support & status
Open app
Select theme
Dark
Light
Auto
Authentication overview
Authentication
Section titled “Authentication”
Verify your API key and inspect the acting workspace identity.
