GoHighLevel in chat
Connect GoHighLevel once for the organisation, then ask Centrus about contacts, pipelines, calendars and conversations, or ask it to book a visit or update a contact.
Checked against the app on
What it does
GoHighLevel connects Centrus chat to one sub-account in your organisation's GoHighLevel account. Once it is set up, you can ask about contacts, pipelines, calendars, conversations, notes, tasks and invoices in an ordinary chat, and Centrus looks the answer up in GoHighLevel while you wait. It can also make changes when you ask, such as booking an appointment or updating a contact. An SMS or an email waits until you confirm.
Connect and manage external services
Configure your organisation's Ostara connection. Other users can then Enable it for chat.
- Look up a work order by number
- Accept a work order
- Set an ETA
- Add a note
Configure your organisation's GoHighLevel connection. Other users can then Enable it for chat.
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Connect a Freshdesk account so chat and automations can read tickets and reply.
- An administrator pastes the Freshdesk subdomain and an agent API key from Profile settings.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- 1Integrations, in the menu on the left.
- 2The GoHighLevel card. It reads Not Connected until an administrator connects it.
- 3Connect, where an organisation administrator enters the token and the Location ID.
- 4How to Use, which explains who connects and what chat can do.
An administrator connects GoHighLevel once for the whole organisation, and everyone else then clicks Enable on the same card. The connection covers that one sub-account only. Agents connect to GoHighLevel separately, on their own step: see GoHighLevel in Agent Builder. GoHighLevel stays the CRM. Centrus reads from it and writes into it.
Before you start
- An organisation administrator to connect it. Centrus accepts the token only from an administrator. For everyone else, Connect stays grey until an administrator has connected, and then it becomes Enable.
- A Private Integration token for the sub-account, not the agency view. In GoHighLevel, open that sub-account, then Settings, Private Integrations, and create the token. It starts with
pit-. - The Location ID for that same sub-account, copied from Business Profile. Chat can use only this one location.
- The scopes ticked on the token: contacts, opportunities, calendars, calendar events, conversations, and locations. Those are the ones the connect window names. Centrus checks the token by reading the location. Invoice questions also need the token to be allowed to read invoices. The window does not say so. If a later question is refused, edit the token and connect again.
Private Integration Token
Starts with pit-. Created under Settings, Private Integrations, in the sub-account. Centrus stores it encrypted.
Location ID
Copied from Business Profile. It picks the one sub-account chat can use.
The token belongs to the organisation, not to one person. Everyone who enables GoHighLevel works through that same token, so a change made from chat is made with it, whoever asked for it. Connecting this card does not connect Agent Builder, and it does not connect any other integration. The Integrations overview explains how an organisation connection differs from a personal sign-in.
Connect GoHighLevel
- 1Open Integrations from the menu on the left and find the GoHighLevel card. It sits with Ostara and Freshdesk.
- 2Click Connect. The Connect GoHighLevel window opens. There is no Cancel on the form. Close the window from the corner if you want to stop.
- 3Paste the Private Integration Token and the Location ID. Both are required. The token box hides what you type. The Location ID box shows an example id until you replace it.
- 4Click Connect.
Configure your organisation's GoHighLevel connection. Other users can then Enable it for chat.
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Connect a Freshdesk account so chat and automations can read tickets and reply.
- An administrator pastes the subdomain and an agent API key.
- Each user then Enables.
Connect a Fixflo account so chat and automations can read issues and push updates.
- An administrator pastes the subdomain and the API token.
- Each user then Enables.
Create the token under Settings, Private Integrations, inside the sub-account. Copy the Location ID from Business Profile. Tick contacts, opportunities, calendars, calendar events, conversations, and locations. Connecting chat does not connect Agent Builder.
*Private Integration Token
••••••••••••••••••••••*Location ID
mfm7RiversideH2026- 1Private Integration Token, hidden as you type. It must start with pit-.
- 2Location ID, the id of the sub-account, from Business Profile.
- 3Connect, which reads that location in GoHighLevel before saving.
Before anything is saved, Centrus uses the token to read GET / at https:/. Only if GoHighLevel accepts the token and returns that location is the connection saved, with the token encrypted. You then see Successfully connected to GoHighLevel. The card changes to Connected, with a green line reading Connected to and the location name GoHighLevel returned, such as Meridian FM. If GoHighLevel does not send a name, the line reads Connected on its own.
Configure your organisation's GoHighLevel connection. Other users can then Enable it for chat.
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Connect a Freshdesk account so chat and automations can read tickets and reply.
- An administrator pastes the subdomain and an agent API key.
- Each user then Enables.
Connect a Fixflo account so chat and automations can read issues and push updates.
- An administrator pastes the subdomain and the API token.
- Each user then Enables.
Create the token under Settings, Private Integrations, inside the sub-account. Copy the Location ID from Business Profile. Tick contacts, opportunities, calendars, calendar events, conversations, and locations. Connecting chat does not connect Agent Builder.
*Private Integration Token
••••••••••••••••••••••*Location ID
mfm7RiversideH2026- 1The message in the window. The same words appear at the top of the page.
If anything is wrong, the window stays open so you can correct it, and the same message appears at the top of the page. The messages you may see are:
- GoHighLevel refused the token. Reconnect, or edit the Private Integration and add the missing scope. GoHighLevel did not accept the token, often because a scope is missing. If GoHighLevel sent a detail, it is included in brackets before the full stop.
- GoHighLevel request failed followed by a status and the path, such as the locations path: the Location ID is wrong, or GoHighLevel could not be reached. The request waits up to 30 seconds.
- Private Integration Token must start with pit-. The token box does not start with those four characters. The window shows this before anything is sent. The server uses a longer form of the same sentence if a request arrives without that prefix.
- Enter the Private Integration Token or Enter the Location ID, under a box: that box is empty.
- Location ID is required. Copy it from Business Profile. The Location ID was blank when it reached the server.
- Only organisation administrators can connect GoHighLevel. Your account is not an administrator. Ask one to connect.
- Could not verify GoHighLevel credentials, or Failed to connect to GoHighLevel, when Centrus has no more specific message from GoHighLevel.
Enable it for everyone else
Once an administrator has connected, everyone else sees Organisation connected by: with that person's name on the card, and the greyed-out Connect becomes Enable. Clicking Enable copies the administrator's connection to your own account, so you never need the token yourself. You see GoHighLevel is ready for your account, and the card shows Connected with the location name. Centrus copies only an administrator's connection. A colleague's copy is not enough for someone else to enable.
Connect GoHighLevel to look up contacts, pipelines, calendars and conversations through Centrus.
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Connect GoHighLevel to look up contacts, pipelines, calendars and conversations through Centrus.
Organisation connected by: John Martin
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Connect GoHighLevel to look up contacts, pipelines, calendars and conversations through Centrus.
✓ Connected to Meridian FM
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Integrations works the same way in a phone browser, with the cards in a single column. Scroll to GoHighLevel and tap Enable. Each person enables once, and GoHighLevel is then available to them in every chat.
Centrus
Connect and manage external services
Connect GoHighLevel to look up contacts, pipelines, calendars and conversations through Centrus.
Organisation connected by: John Martin
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Ask your first questions
Open Chat, start a chat and ask the way you would ask a colleague. GoHighLevel is available in every chat once you have enabled it, whichever tag you choose. How to Use on the card does not list sample questions. It says who connects, that each person then enables, and that chat can look up and update contacts, pipelines, calendars, and SMS or email on that one sub-account.
How to use GoHighLevel with CentrusConnecting chat does not connect Agent Builder.
- An administrator creates a Private Integration token inside the sub-account (Settings, Private Integrations) and copies the Location ID from Business Profile.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can look up and update contacts, pipelines, calendars, and SMS or email on that one sub-account.
- 1The three points How to Use shows. The window has no example questions.
These are useful first questions once the card says Connected for you:
- “Where is Priya Shah in the pipeline?”
- “Which opportunities for Northgate Housing are still open?”
- “What is free on the Surveys calendar next week?”
- “What did we last say to Priya Shah?”
John Martin
last message sent: less than a minute ago
Where is Priya Shah in the pipeline?
Priya Shah at Northgate Housing is on one open opportunity, Riverside House survey, in the Maintenance pipeline:
| Opportunity | Stage | Value | Status |
|---|---|---|---|
| Riverside House survey | Survey booked | £1,840.00 | Open |
Her email is priya.shah@northgatehousing.co.uk and her mobile is 07700 900184.
- 1Worked, naming each look-up in GoHighLevel.
While Centrus works, the panel above the answer names each look-up as it happens, such as Searching contacts in GoHighLevel or Listing calendars in GoHighLevel. When the answer is ready, the panel folds to Worked with the number of steps. Open it to see exactly what Centrus looked up before it answered.
Carry on in the same chat, with “Book her on Thursday at 09:00” or “What notes are on her?”, and Centrus keeps track of the contact you were talking about. A contact search matches the name, email or phone you give. With no name, it returns the first page of contacts in the sub-account.
What you can ask
Centrus has 55 GoHighLevel tools in chat, and picks the right ones from what you ask, so you never choose them yourself. Looking up contacts, pipelines, calendars and conversations is available as soon as you have enabled. A change, such as a note, a task, a tag, a campaign, a workflow or an invoice, is found when you ask. Every tool is listed in the reference.
Contacts
“Find Priya Shah.”
“Update her mobile to 07700 900184.”
Pipelines
“Which Northgate opportunities are open?”
“Move Riverside House survey to Survey booked.”
Calendars
“What survey slots are free next week?”
“Book Priya Shah on Thursday at 09:00.”
Conversations
“What did we last say to Priya Shah?”
“Draft a text that the survey is booked.”
Notes and tasks
“What notes are on Priya Shah?”
“Add a task to call her on Monday.”
Invoices
“Which invoices mention Northgate?”
“What is still unpaid on her invoice?”
Forms
“What forms do we have?”
“Show this week's form submissions.”
Businesses
“Find the business Northgate Housing.”
“Open that business.”
- Contacts. Search by name, email or phone, open one contact, and check whether that email or phone is already on another contact. Centrus can create a contact or update one matched on email or phone, update fields on a contact you already have, and delete a contact. It can add or remove tags, and add or remove followers when you already have the follower's user id.
- Pipelines. List the pipelines and their stages, search opportunities by words, pipeline or status (open, won, lost or abandoned), and open one opportunity. Centrus can create an opportunity, update it, set that status, add or remove followers, and delete an opportunity. A new opportunity needs the pipeline, the contact and a name. If you do not give a status, it is created as open.
- Calendars. List calendars and calendar groups, see free slots, list appointments on a calendar, list the appointments on one contact, and open one appointment. Centrus can book an appointment and update one, including cancelling it by setting the appointment status. There is no separate delete for an appointment.
- Conversations. Search the inbox, including for one contact, and read the messages on a conversation. A read returns at most 20 messages. Centrus can send an SMS or an email. It cannot send WhatsApp or a social message from this card.
- Notes and tasks. List, add, update or delete the notes on a contact. List, add, update, complete or delete the tasks on a contact. A new task needs a title and a due date.
- Invoices. List invoices, open one, and list payment transactions. Centrus can send an invoice, void an invoice, and record a payment that has already been taken. Recording a payment does not charge a card. Listing invoices expects the token to be allowed to read invoices. The connect window does not mention that.
- Forms. List the forms on the sub-account, and list form submissions.
- Businesses. List businesses and open one. The list is the first 20 only.
- Campaigns and workflows. Centrus can add a contact to a campaign or a workflow, or take them off, when you already have that campaign or workflow id. There is no list of campaigns or workflows in chat. It can also take a contact off every campaign, which it will ask you to confirm.
Some questions GoHighLevel answers directly, such as open opportunities, or contacts matching a name. Others need a second pass. Free slots come back for the whole of each day in the range you give. If you ask for mornings only, Centrus reads those slots and keeps the ones that fall in the morning. Give the calendar and the dates, so it is not guessing which calendar you mean.
Appointments with no dates of your own cover today through the next 7 days, in Europe/London. Free slots need a start and an end, and the range cannot be longer than 31 days. Say the dates as 13/10/2026 to 17/10/2026 and Centrus converts them.
John Martin
last message sent: less than a minute ago
Which mornings are free on the Surveys calendar from Monday 13/10/2026 to Friday 17/10/2026?
These mornings are free on Surveys between 13/10/2026 and 17/10/2026. Afternoons are left out:
| Day | Free from | Until |
|---|---|---|
| Monday 13/10/2026 | 09:00 | 12:00 |
| Wednesday 15/10/2026 | 08:30 | 11:00 |
| Thursday 16/10/2026 | 09:00 | 12:30 |
Thursday 16/10/2026 at 09:00 is open. Shall I book Priya Shah then?
Making changes
31 of the 55 tools change data in GoHighLevel. A booking or a contact update shows as its own step in the panel above the answer, such as Creating an appointment in GoHighLevel or Updating a contact in GoHighLevel. Those are the usual changes, and the tool text does not tell Centrus to wait before it writes them.
Centrus is told to confirm before it sends an SMS or an email, deletes a contact, a note, a task or an opportunity, takes a contact off every campaign, or sends or voids an invoice. It restates that change and waits. Booking an appointment, updating a contact, creating or updating an opportunity, adding tags, a note, a task, a follower, a campaign or a workflow, completing a task, and recording a payment are not in that list. Those are written when you ask. Name the contact, give the values, and check the result in GoHighLevel.
John Martin
last message sent: less than a minute ago
Book Priya Shah a survey at Riverside House on Thursday 16/10/2026, 09:00 to 10:00, on the Surveys calendar.
Booked. Priya Shah, Northgate Housing, is on the Surveys calendar:
| When | Until | Where | Calendar |
|---|---|---|---|
| Thursday 16/10/2026, 09:00 | 10:00 | Riverside House | Surveys |
Open it in GoHighLevel to check it. I have not sent her a text.
- 1The booking step. It runs when you ask. An SMS would have waited.
A time you give for an appointment or a task is read as Europe/London, in the form 16/10/2026 at 09:00. Chat has no timezone box of its own. If you leave off the end time, the booking is sent with the start only.
Tags need care. Asking Centrus to update a contact and set their tags replaces the tags already on that contact. Asking it to add tags does not: those are added beside the ones already there. Removing tags removes only the names you give.
Some changes cannot be taken back from chat:
- Deleting a contact, a note, a task or an opportunity removes it from GoHighLevel. Centrus asks you first, and it cannot bring the record back.
- Taking a contact off every campaign removes them from all of them. Centrus asks you first. Taking them off one campaign needs that campaign's id, and that one is not in the confirm list.
- Sending an SMS or an email, and sending an invoice, leave Centrus once you agree. Chat cannot unsend them.
- Voiding an invoice is confirmed first. Chat has no tool to reverse a void.
- Cancelling an appointment is an update: ask Centrus to set the appointment status to cancelled. There is no separate delete. Updating an appointment is not in the confirm list.
- Recording a payment writes the amount you give. It does not charge a card, and it is not in the confirm list.
There is no tool that applies one change to every row of a list. Each contact, appointment or opportunity is its own step. A page of results stays on that chat for 24 hours, so you can say “the next one” without searching again. For an SMS or an email, Centrus still stops and reads the message back before it sends, one contact at a time.
John Martin
last message sent: 1 minute ago
Text Liam Carter as well: his survey at Harbour View Apartments is booked for Friday 17/10/2026 at 11:00.
I have not sent anything. Liam Carter is a separate contact from Priya Shah. Shall I send this SMS to 07700 900221: “Your survey at Harbour View Apartments is booked for Friday 17/10/2026 at 11:00.”?
Who can use it
GoHighLevel has no screen for switching individual tools off. Settings has no GoHighLevel Tools tab, and editing a team does not list GoHighLevel tools either. The Integrations overview describes the tool screens that BigChange REST and Simpro do have. For GoHighLevel, what someone can do is decided by two things: whether an administrator has connected, and whether that person has clicked Enable.
Configure your organisation's GoHighLevel connection. Other users can then Enable it for chat.
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Connect GoHighLevel to look up contacts, pipelines, calendars and conversations through Centrus.
Organisation connected by: John Martin
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
- 1The Settings tabs. GoHighLevel is not among them.
- 2Connect, shown to an organisation administrator.
- 3Enable, which turns on every GoHighLevel tool for that person. The seven lines on the card are the same for everyone.
What the token is allowed to do in GoHighLevel applies to everyone who has enabled, because they share that token. The extra control in chat is the confirm step, and only for the changes named above. Once you agree to an SMS, the step appears, such as Sending a message via GoHighLevel.
John Martin
last message sent: less than a minute ago
Yes, send it.
Sent. Liam Carter has the SMS: his survey at Harbour View Apartments is booked for Friday 17/10/2026 at 11:00.
Limits
- Pages of 20. Contacts, opportunities, appointments, conversations, invoices, form submissions and transactions come back 20 at a time. Ask for the next page in the same chat. That page is kept for 24 hours, on that chat. After that, or in a new chat, Centrus asks GoHighLevel again.
- Businesses. The list is the first 20, and there is no next page.
- Messages. One conversation returns at most 20 messages.
- Free slots. The range cannot be longer than 31 days. Dates are a day, such as 13/10/2026. A longer range comes back as Free slots cover at most 31 days. Narrow startDate and endDate.
- Appointments with no dates. The list is today through the next 7 days, Europe/London. Name the calendar. Without one, Centrus lists calendars first.
- Times you give. An appointment or a task due time is read as Europe/London. The connect window has no timezone box. The Agent Builder step does: see the sister article. A time that is not a day and a time in that form comes back as Time must be YYYY-MM-DDTHH:mm in Europe/London.
- One sub-account. The Location ID on the card is the only location chat can see. Another sub-account needs its own token and its own connection, which means the administrator connects again.
- One record at a time. There is no bulk change. See Making changes.
- Tags on an update. Setting tags while creating or updating a contact replaces the tags already there. Adding tags does not.
- Ids you must already have. Campaigns, workflows and followers need their ids. Chat cannot list workflows, campaigns or users.
- When GoHighLevel is busy. There is no automatic retry. A busy response is GoHighLevel is busy. Try again in a moment. Each request waits up to 30 seconds.
- SMS and email only. WhatsApp and social channels are not available from this card.
- Scopes. The connect window lists contacts, opportunities, calendars, calendar events, conversations and locations. An invoice question whose token is not allowed to read invoices fails with the refused-token message, or with GoHighLevel request failed and the path. There is no separate invoice message.
John Martin
last message sent: less than a minute ago
Which opportunities are still open?
The Working line names the look-up while Centrus is fetching it. It does not count pages or rows while it runs. A long list is still one page of 20 inside that step. When the answer is ready, the line folds into Worked. Ask Centrus to carry on for the next 20.
Disconnect
Disconnect on the card removes your own connection only. It happens straight away, without asking you to confirm, and you see Integration disconnected. If an administrator's connection is still there to copy, the card goes back to Enable for anyone who is not an administrator. An administrator who disconnects sees Connect again.
Connect GoHighLevel to look up contacts, pipelines, calendars and conversations through Centrus.
✓ Connected to Meridian FM
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
Connect GoHighLevel to look up contacts, pipelines, calendars and conversations through Centrus.
Organisation connected by: John Martin
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
- Invoices
- Create or update a contact or opportunity
- Book an appointment, or send SMS or email after you confirm
- 1Disconnect, which removes your own connection without asking you to confirm.
- 2Enable, to turn GoHighLevel back on from the administrator's connection.
When an administrator disconnects, only that administrator's connection goes. Everyone who has already enabled keeps working, because each person holds their own copy of the token. Someone who has not enabled cannot turn it on from a colleague's copy. They see the grey Connect until an administrator connects again.
To stop all access from Centrus at once, delete or edit the Private Integration in GoHighLevel, and every copy stops working. Copies do not pick up a new token by themselves. Once a new token is issued, the administrator connects again and everyone else clicks Disconnect, then Enable.
Troubleshooting
- Centrus answers as though GoHighLevel is not connected. Check that the card says Connected for you, and click Enable if it shows Organisation connected by. If you are not an administrator and Connect is still grey, nobody has connected yet. Ask an administrator to connect.
- No GoHighLevel connection found. Please ask your administrator to connect first. You clicked Enable, but no administrator's connection is left to copy. Ask an administrator to connect.
- GoHighLevel refused the token, in the answer or in the connect window. The token was changed, withdrawn, or is missing a scope. The administrator connects again with a current token, then everyone else clicks Disconnect and Enable.
- GoHighLevel request failed, with a status and a path. The Location ID may be wrong, or GoHighLevel returned an error for that call. The window or the answer includes the path, such as the locations path while connecting.
- GoHighLevel is busy. Try again in a moment. Ask again in a minute. Centrus does not retry on its own.
- Private Integration Token must start with pit-. Paste the token again, including the pit- at the start, with no space in front of it.
- Stored GoHighLevel token is invalid. Please reconnect. or GoHighLevel credentials are incomplete. Please reconnect. Your copy of the token can no longer be read. Click Disconnect, then Enable, to take a fresh copy. If you are the administrator, click Connect and paste the token again.
- Free slots cover at most 31 days. Shorten the range and ask again.
- Time must be YYYY-MM-DDTHH:mm in Europe/London. Give the day and the time, such as 16/10/2026 at 09:00. Chat treats that as London time.
- An invoice question fails, and contacts still work. The token can read the location but is not allowed to read invoices. Edit the Private Integration, allow invoices, then have the administrator connect again and everyone else click Disconnect and Enable.
- A workflow, campaign or follower change cannot find the id. Chat has no list of those. Copy the id from GoHighLevel and include it in the question.
- The answer stops after 20 rows. Ask Centrus to carry on. The saved page lasts 24 hours. After that, ask for the list again. Businesses stop at 20.
John Martin
last message sent: less than a minute ago
Where is Priya Shah in the pipeline?
I couldn't look up Priya Shah. GoHighLevel refused the token, which usually means the Private Integration was changed or a scope was removed. Ask your administrator to reconnect GoHighLevel on the Integrations page.
Tools and endpoints reference
There are 55 GoHighLevel tools in chat: 24 read from GoHighLevel and 31 change data. The names below are the labels used for the same actions in Agent Builder. Every tool calls GoHighLevel at https:/. Where a path contains {contactId} or another name in braces, Centrus fills it from the contact, opportunity, calendar or invoice you named. {locationId} is the Location ID on the connection. An SMS, an email, a delete, sending or voiding an invoice, and removing a contact from every campaign still wait until you confirm. Booking an appointment and updating a contact do not.
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Search contacts | Finds contacts in the connected sub-account by name, email or phone. With no query, returns the first page of 20. | Reads | POST / |
| Get contact | Reads one contact. The id comes from a search. | Reads | GET / |
| Get duplicate contact | Checks whether an email or a phone is already on a contact. At least one of them is required. | Reads | GET / |
| Upsert contact | Creates a contact, or updates one matched on email or phone. Needs an email or a phone, and a first name or a name. Tags sent here replace the contact's tags. | Changes | POST / |
| Update contact | Updates fields on a contact you already have. Tags sent here replace the contact's tags. Written when you ask. | Changes | PUT / |
| Delete contact | Permanently deletes a contact. Centrus asks you first. Chat cannot restore it. | Changes | DELETE / |
| Add contact tags | Adds the tags you name. Existing tags stay. | Changes | POST / |
| Remove contact tags | Removes only the tags you name. | Changes | DELETE / |
| List contact notes | Lists the notes on one contact. | Reads | GET / |
| Create contact note | Adds a note. The text is the body. | Changes | POST / |
| Update contact note | Replaces the text of one note. | Changes | PUT / |
| Delete contact note | Deletes one note. Centrus asks you first. | Changes | DELETE / |
| List contact tasks | Lists the tasks on one contact. | Reads | GET / |
| Create contact task | Adds a task. Title and due date are required. A new task is not completed unless you say it is. | Changes | POST / |
| Update contact task | Changes only the task fields you name. | Changes | PUT / |
| Complete contact task | Marks one task completed. | Changes | PUT / |
| Delete contact task | Deletes one task. Centrus asks you first. | Changes | DELETE / |
| List contact appointments | Lists appointments for one contact. | Reads | GET / |
| Add contact followers | Adds followers. You need their user ids. Chat cannot list users. | Changes | POST / |
| Remove contact followers | Removes the followers whose user ids you give. | Changes | DELETE / |
| Add contact to campaign | Adds the contact to one campaign. You need the campaign id. There is no campaign list. | Changes | POST / |
| Remove contact from campaign | Takes the contact off one campaign. You need the campaign id. | Changes | DELETE / |
| Remove contact from all campaigns | Takes the contact off every campaign. Centrus asks you first. | Changes | DELETE / |
| Add contact to workflow | Adds the contact to one workflow. You need the workflow id. There is no workflow list. | Changes | POST / |
| Remove contact from workflow | Takes the contact off one workflow. You need the workflow id. | Changes | DELETE / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| List pipelines | Lists pipelines and their stages for the connected sub-account. | Reads | GET / |
| Search opportunities | Lists pipeline deals. You can filter by words, pipeline and status: open, won, lost or abandoned. Pages of 20. | Reads | GET / |
| Get opportunity | Reads one opportunity. | Reads | GET / |
| Create opportunity | Creates an opportunity. Needs the pipeline, the contact and a name. Status defaults to open. Written when you ask. | Changes | POST / |
| Update opportunity | Updates the pipeline, stage, name, status or value. Send only what you want changed. | Changes | PUT / |
| Update opportunity status | Sets the status to open, won, lost or abandoned. This is separate from the general update. | Changes | PUT / |
| Delete opportunity | Permanently deletes an opportunity. Centrus asks you first. | Changes | DELETE / |
| Add opportunity followers | Adds followers. You need their user ids. | Changes | POST / |
| Remove opportunity followers | Removes the followers whose user ids you give. | Changes | DELETE / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| List calendars | Lists calendars in the connected sub-account. Use one when you ask for free slots or a booking. | Reads | GET / |
| List calendar groups | Lists calendar groups for the connected sub-account. | Reads | GET / |
| Get free slots | Reads free slots on one calendar. Start and end are dates, and the range cannot exceed 31 days. | Reads | GET / |
| List appointments | Lists appointments on one calendar. With no dates, the window is today through the next 7 days. Pages of 20. | Reads | GET / |
| Get appointment | Reads one appointment. | Reads | GET / |
| Create appointment | Books an appointment. Needs the calendar, the contact and a start time in Europe/London. Written when you ask. | Changes | POST / |
| Update appointment | Changes only the fields you name, including the appointment status used to cancel. There is no separate delete. Times are Europe/London. | Changes | PUT / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Search conversations | Lists inbox threads. You can pass words or a contact. Pages of 20. | Reads | GET / |
| Get messages | Reads messages on one conversation. At most 20. | Reads | GET / |
| Send message | Sends an SMS or an email to a contact. Email needs a subject and a body. Centrus asks you first. Not for WhatsApp or social channels. | Changes | POST / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| List invoices | Lists invoices for the connected sub-account. You can filter by status, dates and search. Pages of 20. Needs the invoice scopes. | Reads | GET / |
| Get invoice | Reads one invoice. | Reads | GET / |
| List transactions | Lists payment transactions for the connected sub-account. Pages of 20. | Reads | GET / |
| Send invoice | Sends the invoice. Centrus asks you first. | Changes | POST / |
| Void invoice | Voids the invoice. Centrus asks you first. Chat cannot reverse it. | Changes | POST / |
| Record invoice payment | Records a payment already taken. The amount is required. This does not charge a card, and it is written when you ask. | Changes | POST / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Search businesses | Lists businesses for the connected sub-account. The first 20 only, with no next page. | Reads | GET / |
| Get business | Reads one business. | Reads | GET / |
| List forms | Lists forms for the connected sub-account. | Reads | GET / |
| List form submissions | Lists form submissions for the connected sub-account. Pages of 20. | Reads | GET / |
| List location tags | Lists the tags defined on the connected sub-account. | Reads | GET / |