FreeScout API

12 endpoints for FreeScout, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.

Base URL: https://cotlet.dev/api/v1/freescout
Connects with: Your own FreeScout agent login on your instance address (Support Agent or Administrator). What your agent can do follows your role and mailbox permissions.
Integration page: FreeScout

Read (6)

Return data and change nothing in the account.

FreeScout Endpoints: Read
Endpoint	Description
GET /mailboxes	Mailboxes your FreeScout account can open, with their IDs and email addresses.
GET /mailbox/{mailbox_id}/users	The people you can assign conversations to in one mailbox.
GET /mailbox/{mailbox_id}/conversations	Conversations of one mailbox by status, assignee or search text, with who wrote last.
GET /conversations/{conversation_id}	One conversation with every thread, oldest first, internal notes marked.
GET /customers	Customers matching a name, email address or phone number.
GET /customers/{customer_id}	A customer profile with the conversations they started.

Change the account. Calls marked Confirm wait for the user to approve them.

FreeScout Endpoints: Write
Endpoint	Description
POST /conversations/{conversation_id}/notes Confirm	Add an internal note to a conversation. The customer does not see it.
POST /conversations/{conversation_id}/customer/replies Confirm	Send a reply to the customer, or save it as a draft for you to send.
PUT /conversations/{conversation_id}/status	Set a conversation to Active, Pending, Closed or Spam.
POST /conversations/{conversation_id}/assign Confirm	Assign a conversation to a teammate, or leave user_id out to unassign it.
POST /mailbox/{mailbox_id}/conversations/{conversation_id}/move Confirm	Move a conversation to another mailbox.
POST /merge-intos/{merge_into_id}/conversations/{conversation_id}/merge Confirm	Merge one conversation into another.