{"info":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","description":"

Welcome to the FuseDesk API!

The FuseDesk API allows you to integrate your own custom solutions with your FuseDesk Help Desk and Messaging Platform.

Specifically, you're able to work with FuseDesk Cases, Emails, Contacts, Reps, and more!

Don't have a FuseDesk app yet? Get your own Free FuseDesk App and start developing today!

Error Reporting

If an error occurs, we’ll return back HTTP Status of not 200 (i.e. 405) along with an encoded error message.

Response Headers will include:

X-FuseDesk-Error-Code The error code string, i.e. api_error_noscope
X-FuseDesk-Error An error message string, i.e. Not Authorized

HTTP Status Codes

200: Success (OK)
401: Invalid authorization credentials (Unauthorized – Check your API Key)
403: Not authorized for that action (Forbidden – Check the API Key’s permissions)
404: Unsupported method or format (Not Found – Check the URL) or object not foudn (Check that the item wasn't deleted)
405: Other Error (See what’s returned back for more info)
429: Rate Limit Exceeded (Stop hammering the API for a bit)

Rate Limiting

In our response headers, we'll include two headers indicating your current hourly API rate limit and how many API calls you have remaining. Please respect these API limits and incrementally back off before you run out of API Calls.

Response Headers will include:

X-FuseDesk-Usage-Limit How many API calls you get per hour, i.e. 1800
X-FuseDesk-Usage-Remaining How many API calls you have available, i.e. 1712

Data Formats

Data is currently returned back as JSON

Dates are returned back as ISO 8601 dates, i.e. 2019-02-12T15:19:21+00:00

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Error Reporting","slug":"error-reporting"},{"content":"HTTP Status Codes","slug":"http-status-codes"},{"content":"Rate Limiting","slug":"rate-limiting"},{"content":"Data Formats","slug":"data-formats"}],"owner":"11014835","collectionId":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","publishedId":"SztBc8ix","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-05-28T03:51:04.000Z"},"item":[{"name":"Authentication","item":[{"name":"Authorization with HTTP Headers","id":"892e9bdc-9853-4cec-9b9c-e75afeb7d9d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

Your FuseDesk API Key

\n","key":"X-FuseDesk-Api-Key","type":"text","value":"YOURAPIKEY","warning":"This is a duplicate header and will be overridden by the X-FuseDesk-Api-Key header generated by Postman."}],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/emails/unassigned","description":"

The best way to authenticate an API Call is with an HTTP Header.

Simply pass your API Key in the header as X-FuseDesk-Api-Key. Note that this is case sensitive.

In this example, we request unassigned emails using the HTTP Header for authentication.

Your FuseDesk API Key

The best way to authenticate an API Call is with an HTTP Header.

Simply pass your API Key in the header as X-FuseDesk-Api-Key. Note that this is case sensitive.

In this example, we request unassigned emails using the HTTP Header for authentication.

You can also simply authenticate as a user by POSTing to the /api/v1/auth/ endpoint using an email and password. Your session cookie will then be able to take further actions as the logged in user so long as you include your session cookie in subsequent requests.

You can set requestToken to true to get back a JWT Token for use in future API calls instead.

You can optionally MD5 encrypt your password before sending and set md5 to true .

\n","urlObject":{"protocol":"https","path":["api","v1","auth"],"host":["YOURAPPNAME","fusedesk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"968568e1-d3dc-4dd6-8bf9-93c38e8880f3"},{"name":"Authorization with Bearer Token","id":"a345b923-d5c5-47fd-af0a-f53bd3f59bfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JwtToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/emails/unassigned","description":"

Lastly, you can pass in a JWT Bearer Token in your headers.

In this example, we request unassigned emails using a bearer token for authentication.

How do you get a token? Easy! Authenticate as a User using email and password (see above) and include the requestToken param set to true.

\n","urlObject":{"protocol":"https","path":["api","v1","emails","unassigned"],"host":["YOURAPPNAME","fusedesk","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a345b923-d5c5-47fd-af0a-f53bd3f59bfe"}],"id":"5a19ddc0-04af-4bf0-8bdc-f6c2626dd060","description":"

All of your API calls to the FuseDesk API need to be authorized. Authorization can be done in a number of ways:

Most commonly with an API Key in your Request Headers.
An API Key in your query params
As a authenticated user using a session cookie
With a JWT Token

You can create API Keys under Settings in your FuseDesk app.

API Key Permissions/Scope

Each API Key can be set with a number of permissions for what it has access to do.

For example, if you’re putting your API Key on a site where all you want it to be able to do is create a new case, then you can just give that key permission to create cases, but not read any data or do anything but add cases.

If you’re building a form and want to provide access to your departments list, you can provide permissions to read departments, and so on.

Generally, pick the most restrictive permission set you need to provide the functionality you need.

If you’re writing your own app that you want to make available to other folks to access their FuseDesk data via the API, please make sure to let folks know what permissions you require.

Authenticating via the API

If you’re using a third party app to access FuseDesk via the FuseDesk API, then all you’ll need to do is paste in your FuseDesk app name and the API Key you created.

If you’re writing your own script or configuring a more advanced integration, you have a few ways to authenticate.

Authenticating via HTTP Headers

Pass your API Key in the HTTP Headers with the header X-FuseDesk-API-Key. Note that this is case sensitive.

For example, to get a list of all unassigned emails:

curl --request GET\n--header \"X-FuseDesk-API-Key: YOURAPIKEY\"\nhttps://YOURAPPNAME.fusedesk.com/api/v1/emails/unassigned\n\n

Replace YOURAPIKEY with your API Key.

Authenticating via Query Parameter

Pass your API Key as a GET/POST param with the parameter apikey. Note that this is case sensitive.

For example, to get a list of unassigned emails:

curl --request GET\n--data '{\"apikey\":\"YOURAPIKEY\"}'\nhttps://YOURAPPNAME.fusedesk.com/api/v1/emails/unassigned```\n\n

Replace YOURAPIKEY with your API Key.

\n\n

Authenticating with a JWT Bearer Token

If you logged in with an email and password (see above), you can include a requestToken param set to 1 to get back a JWT Token that you can use in future API calls.

Failed Authentication

If your API Key is invalid, or you don’t have permission to do what you’re trying to do, we’ll return back an error.

\n","event":[{"listen":"prerequest","script":{"id":"01cd73fe-2f59-44dc-8c5c-692ae6333125","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d682a07c-c1f5-453f-a1ac-27798baad02a","type":"text/javascript","exec":[""]}}],"_postman_id":"5a19ddc0-04af-4bf0-8bdc-f6c2626dd060","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Cases","item":[{"name":"Search Cases","id":"312f3a20-e8bb-4bff-a73e-b9d075ced263","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/?contactid&contactUuid&email&companyid&status&limit&offset&orderby&repid&createdByRep&depid&from&subject&date_opened&date_assigned&date_firstresponse&date_closed&date_updated","description":"

Search for matching cases.

For date fields, you have a few options. You can filter by

On a specific date, i.e. date_opened = '2014-04-16'
Before a date, i.e. date_closed = {\"before\":\"2014-02-14\"}
After a date, i.e. date_assigned = {\"after\":\"2014-05-02\"}
Between two dates, i.e. date_closed = {\"after\":\"2014-04-14\", \"before\":\"2015-05-15\"}

Dates just need to be PHP parsable date strings which means they can be relative dates, too, i.e. -4 days for \"4 days ago\"

The CRM Contact ID for a case to be linked to

\n","type":"text/plain"},"key":"contactid","value":null},{"description":{"content":"

The FuseDesk Contact ID for a case to be linked to

\n","type":"text/plain"},"key":"contactUuid","value":null},{"description":{"content":"

The email address of a contact for a case to be linked to

\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"

The CRM Company ID for a case to be linked to

\n","type":"text/plain"},"key":"companyid","value":null},{"description":{"content":"

Cases Statuses (CSV). Any of active, new, open, snoozed, or closed

\n","type":"text/plain"},"key":"status","value":null},{"description":{"content":"

How many cases to return. Max of 500, default of 150

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

Optional offset for paging. Default of 0

\n","type":"text/plain"},"key":"offset","value":null},{"description":{"content":"

How to order your cases. CSV or Array of field names followed by optional asc or desc. Supported fields are status, caseid, contactid, date_opened, date_assigned, date_firstresponse, date_lastresponse, date_updated, date_closed. Example \"status, date_lastresponse desc, date_updated desc\"

\n","type":"text/plain"},"key":"orderby","value":null},{"description":{"content":"

The FuseDesk User ID (int) that the case is assigned to. Can be just an ID, a CSV of IDs, or an Array of IDs.

\n","type":"text/plain"},"key":"repid","value":null},{"description":{"content":"

The FuseDesk User ID (int) that create the case .Can be just an ID, a CSV of IDs, or an Array of IDs.

\n","type":"text/plain"},"key":"createdByRep","value":null},{"description":{"content":"

The FuseDesk Department ID (int) that the case is assigned to. Can be just an ID, a CSV of IDs, or an Array of IDs.

\n","type":"text/plain"},"key":"depid","value":null},{"description":{"content":"

String to search for in who the case is assigned to, i.e. the contact's name.

\n","type":"text/plain"},"key":"from","value":null},{"description":{"content":"

String to search for in the case title

\n","type":"text/plain"},"key":"subject","value":null},{"description":{"content":"

The date that a case was opened or date range (see notes above)

\n","type":"text/plain"},"key":"date_opened","value":null},{"description":{"content":"

The date that a case was assigned or date range (see notes above)

\n","type":"text/plain"},"key":"date_assigned","value":null},{"description":{"content":"

The date that a case was first responded to or date range (see notes above)

\n","type":"text/plain"},"key":"date_firstresponse","value":null},{"description":{"content":"

The date that a case was resolved or date range (see notes above)

\n","type":"text/plain"},"key":"date_closed","value":null},{"description":{"content":"

The date that a case was updated or date range (see notes above)

\n","type":"text/plain"},"key":"date_updated","value":null}],"variable":[]}},"response":[],"_postman_id":"312f3a20-e8bb-4bff-a73e-b9d075ced263"},{"name":"Create a Case","id":"760ba74c-07f2-4f43-a057-b0417d12e694","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"openedby","value":"","type":"text","description":"

The name of who opened the case, i.e. your customer's name (Required)

\n"},{"key":"summary","value":"","type":"text","description":"

A short title or description of the case (Required)

\n"},{"key":"details","value":"","type":"text","description":"

A longer description of what this case is about (Required)

\n"},{"key":"depid","value":"","type":"text","description":"

The ID of the FuseDesk department this case should be assigned to. (Required)

\n"},{"key":"repid","value":"","type":"text","description":"

The FuseDesk UserID that the case is assigned to

\n"},{"key":"contactUuid","value":"","type":"text","description":"

The FuseDesk Contact UUID

\n"},{"key":"contactid","value":"","type":"text","description":"

The Contact ID from your CRM

\n"},{"key":"companyid","value":"","type":"text","description":"

The Company ID from your CRM

\n"},{"key":"status","value":"","type":"text","description":"

The Case status, one of new, open, closed. defaults to new

\n"},{"key":"casetags","value":"","type":"text","description":"

A CSV or Array of FuseDesk Case Tag IDs (ints) and/or Case Tag Names (strings). Any case tags strings not found will be created. For example 23,293,New Tag Name

\n"},{"key":"date_opened","value":"","type":"text","description":"

The date/time the case was created

\n"},{"key":"date_assigned","value":"","type":"text","description":"

The date/time the case was assigned to a rep

\n"}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/","description":"

Create a new FuseDesk Case.

This loads an entire case and it's case history.

Case ID

\n","type":"text/plain"},"type":"string","value":"","key":"caseId"}]}},"response":[],"_postman_id":"7fab000b-8f38-440c-bfa9-c9630e9af8c2"},{"name":"Update a Case","id":"62bfa40e-747e-4b05-97cf-c15e84ffe55d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

An updated short title or description of the case

\n","key":"summary","type":"text","value":""},{"description":"

An updated longer description of what this case is about

\n","key":"details","type":"text","value":""},{"description":"

The CRM Contact ID to relink the case to

\n","key":"contactid","type":"text","value":""},{"description":"

The FuseDesk Contact UUID to relink the case to

\n","key":"contactUuid","type":"text","value":""},{"description":"

The CRM Company ID to relink the case to

\n","key":"companyid","type":"text","value":""},{"description":"

Status to change the cases to. One of new, open, closed, keepclosed, or unopen

\n","key":"status","type":"text","value":""},{"description":"

The FuseDesk UserID of the rep to transfer the case to

\n","key":"repid","type":"text","value":""},{"description":"

The ID of the FuseDesk department to transfer the case to

\n","key":"depid","type":"text","value":""}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId","description":"

This updates an existing case. Just POST the fields you want to update (See Create a Case above for available fields)

Case ID

\n","type":"text/plain"},"type":"string","value":"","key":"caseId"}]}},"response":[{"id":"484e56f6-0f62-4640-9f45-e1837ed4a0b2","name":"Transfer a Case","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"repid","value":"17","type":"text","description":"The FuseDesk UserID of the rep to transfer the case to"},{"key":"depid","value":"284","type":"text","description":"The ID of the FuseDesk department to transfer the case to"}]},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","cases",":caseId"],"variable":[{"description":"Case ID","key":"caseId","value":"S183XU48"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"69fdb7a0-fb55-416e-951b-538ed034c565","name":"Relink a Case to a Different Contact","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"contactUuid","value":"d8639622-7bf4-48e8-b15d-869676f563eb","type":"text","description":"The FuseDesk Contact UUID to relink the case to"}],"options":{"raw":{"language":"json"}}},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","cases",":caseId"],"variable":[{"description":"Case ID","key":"caseId","value":"S183XU48"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"6d53a18c-d563-4149-9c77-3d616c156763","name":"Close a Case","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"status","value":"closed","description":"Status to change the cases to. One of `new`, `open`, `closed`, `keepclosed`, or `unopen`","type":"text"}]},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","cases",":caseId"],"variable":[{"description":"Case ID","key":"caseId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"62bfa40e-747e-4b05-97cf-c15e84ffe55d"},{"name":"Bulk Update Cases","id":"be7213cd-a217-4953-9090-7095216f3356","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/update/?caseids&tagid&status&repid&depid&crmAutomationId&crmTagId&snooze&merge","description":"

Use Bulk Update to take bulk actions on a group of cases, for example, changing the case status.

CSV or array of Case IDs to bulk update (Required)

\n","type":"text/plain"},"key":"caseids","value":null},{"description":{"content":"

Case Tag ID, CSV of Case Tag IDs or an array of Case Tag IDs to apply.

\n","type":"text/plain"},"key":"tagid","value":null},{"description":{"content":"

Status to change the cases to. One of new, open, closed, keepclosed, or unopen

\n","type":"text/plain"},"key":"status","value":null},{"description":{"content":"

The FuseDesk User ID (int) to reassign the case to. Can be just an ID, a CSV of IDs, or an Array of IDs.

\n","type":"text/plain"},"key":"repid","value":null},{"description":{"content":"

The FuseDesk Department ID (int) to reassign the case to. Can be just an ID, a CSV of IDs, or an Array of IDs.

\n","type":"text/plain"},"key":"depid","value":null},{"description":{"content":"

The ID of the CRM Automation to run on each of the linked contacts

\n","type":"text/plain"},"key":"crmAutomationId","value":null},{"description":{"content":"

The ID of the CRM Tag to apply to each of the linked contacts

\n","type":"text/plain"},"key":"crmTagId","value":null},{"description":{"content":"

What date/time to snooze the cases until

\n","type":"text/plain"},"key":"snooze","value":null},{"description":{"content":"

Set to any truthy value to merge the requested cases

\n","type":"text/plain"},"key":"merge","value":null}],"variable":[]}},"response":[],"_postman_id":"be7213cd-a217-4953-9090-7095216f3356"},{"name":"Apply a Case Tag","id":"5afd2da9-d6c8-41ee-b93b-41b0d5ddd7bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId/tag/:caseTagId","description":"

Apply a Case Tag to a FuseDesk Case

Remove a Case Tag from a FuseDesk Case

The type of note. note or call (Required)

\n","key":"type","type":"text","value":""},{"description":"

The title of the note (Required)

\n","key":"title","type":"text","value":""},{"description":"

The body of the note (Required)

\n","key":"note","type":"text","value":""},{"description":"

The FuseDesk UserID of the rep that added this note

\n","key":"repid","type":"text","value":""},{"description":"

The ID of the note template used

\n","key":"templateid","type":"text","value":""},{"description":"

The status of the case after this note is added. One of new, open, closed.

\n","key":"status","type":"text","value":""}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId/addnote","description":"

Adds a Note to a FuseDesk Case

The to line of your email. If an empty string, defaults to the contact's email address. (Required)

\n","key":"to","type":"text","value":""},{"description":"

The from line of your email. (Required)

\n","key":"from","type":"text","value":""},{"description":"

The CC line of your email. Can be an empty string. (Required)

\n","key":"cc","type":"text","value":""},{"description":"

The BCC line of your email. Can be an empty string. (Required)

\n","key":"bcc","type":"text","value":""},{"description":"

The plain text email body. If not provided, we'll convert html to plain text for you.

\n","key":"body","type":"text","value":""},{"description":"

The HTML email body. If not provided, we'll convert body to HTML for you.

\n","key":"html","type":"text","value":""},{"key":"templateid","value":"","description":"

The FuseDesk Email Template ID that you'd like to use either entirely or for defaults.

\n","type":"text"}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId/reply","description":"

Replies to a case via email. If you pass in a templateid, you can reply with just the template, or override just certain fields as needed.

Email addresses for to, from, cc, and bcc can be just an email address like user@domain.tld or a name and email like \"User Name\" <user@domain.tld>.

The to, from, cc, and bcc fields are all required unless you include a valid Email Template ID (templateid) in which case they all become optional. If provided, the override the template.

to, if an empty string, will default to the contact's email address.

cc and bcc can be empty strings.

You need one, two, or all three of an HTML Body (html), Plain Text Body (body), and/or an Email Template ID (templateid) to send a reply.

Valid Merge Fields are allowed in all text fields.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","cases",":caseId","reply"],"host":["YOURAPPNAME","fusedesk","com"],"query":[],"variable":[{"type":"string","value":"","key":"caseId"}]}},"response":[{"id":"11f80c57-20a0-42d0-a64c-0d70b5e729d7","name":"Reply to a Case by Email","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"The to line of your email. If an empty string, defaults to the contact's email address. (Required)","key":"to","type":"text","value":"~Contact.emailAddress~"},{"description":"The from line of your email. (Required)","key":"from","type":"text","value":"\"VIP Support\" "},{"description":"The CC line of your email. Can be an empty string. (Required)","key":"cc","type":"text","value":""},{"description":"The BCC line of your email. Can be an empty string. (Required)","key":"bcc","type":"text","value":""},{"description":"The plain text email body. If not provided, we'll convert `html` to plain text for you.","key":"body","type":"text","value":"Hi! Thanks for your email!"}]},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId/reply","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","cases",":caseId","reply"],"variable":[{"key":"caseId","value":"738254"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"emailid\": 2991408\n}"},{"id":"4df0b209-8775-4203-917e-55c2fa30fe48","name":"Reply to a Case by Email (Invalid Template ID)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"The to line of your email. (Required)","key":"to","type":"text","value":""},{"description":"The from line of your email. (Required)","key":"from","type":"text","value":""},{"description":"The CC line of your email","key":"cc","type":"text","value":""},{"description":"The BCC line of your email","key":"bcc","type":"text","value":""},{"description":"The plain text email body. If not provided, we'll convert `html` to plain text for you.","key":"body","type":"text","value":""},{"description":"The HTML email body. If not provided, we'll convert `body` to HTML for you.","key":"html","type":"text","value":""},{"key":"templateid","value":"123","description":"The FuseDesk Email Template ID that you'd like to use either entirely or for defaults.","type":"text"}]},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId/reply","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","cases",":caseId","reply"],"variable":[{"key":"caseId","value":"738254"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FuseDesk-Error-Code","value":"api_template_notfound"},{"key":"X-FuseDesk-Error","value":"Unable to load the email template with that ID."},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Unable to load the email template with that ID.\",\n \"errorcode\": \"api_template_notfound\"\n}"},{"id":"81cf6069-24e4-4ba7-bf49-84bcebf2c160","name":"Reply to a Case by Email (Missing required params)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"The to line of your email. (Required)","key":"to","type":"text","value":""},{"description":"The from line of your email. (Required)","key":"from","type":"text","value":""},{"description":"The CC line of your email","key":"cc","type":"text","value":""},{"description":"The BCC line of your email","key":"bcc","type":"text","value":""},{"description":"The plain text email body. If not provided, we'll convert `html` to plain text for you.","key":"body","type":"text","value":""},{"description":"The HTML email body. If not provided, we'll convert `body` to HTML for you.","key":"html","type":"text","value":""},{"key":"templateid","value":"","description":"The FuseDesk Email Template ID that you'd like to use either entirely or for defaults.","type":"text"}]},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId/reply","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","cases",":caseId","reply"],"variable":[{"key":"caseId","value":"738254"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FuseDesk-Error-Code","value":"api_cases_reply_incomplete"},{"key":"X-FuseDesk-Error","value":"You must specify a TemplateID or Body field to reply."},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"You must specify a TemplateID or Body field to reply.\",\n \"errorcode\": \"api_cases_reply_incomplete\"\n}"}],"_postman_id":"209dae86-c3c5-404c-aaea-d21e9c551b45"},{"name":"Snooze a Case","id":"ba5d9b6a-2cb6-4d74-a798-a69baaa9ce27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"

The date and time when to snooze the case until. Can be relative, too, i.e. +3 days

\n","key":"until","type":"text","value":""}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/cases/:caseId/snooze","description":"

Snoozes a FuseDesk Case until a later date and time.

Returns back the current rating and feedback on a case

Disables asking for feedback after a case is closed.

Re-enables asking for feedback after a case is closed.

Requests feedback on a case right now.

Cases are one of the most central objects that you'll work with in the FuseDesk API.

\n","event":[{"listen":"prerequest","script":{"id":"c7db95b7-8a85-4e28-9a53-692230a5f9a8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"17bcfa26-e3fb-46ca-93cd-5451ccf55e73","type":"text/javascript","exec":[""]}}],"_postman_id":"2b98fa6c-65b1-48ce-97a4-c001a6ac6997","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Emails","item":[{"name":"Search Emails","id":"769f8f25-7063-4f31-8646-82fbd211b994","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/emails/unassigned/?orderby&limit&offset&bodylimit&content&subject&from","description":"

Searches all emails.

How to sort the emails.

\n","type":"text/plain"},"key":"orderby","value":null},{"description":{"content":"

How many emails to return

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

What email to start with (for paging)

\n","type":"text/plain"},"key":"offset","value":null},{"description":{"content":"

How many characters of each emails body to return. Defaults to 150.

\n","type":"text/plain"},"key":"bodylimit","value":null},{"description":{"content":"

Text to search for in the email

\n","type":"text/plain"},"key":"content","value":null},{"description":{"content":"

Text to search for in the email subject line

\n","type":"text/plain"},"key":"subject","value":null},{"description":{"content":"

Text to search for in the from part of the email

\n","type":"text/plain"},"key":"from","value":null}],"variable":[]}},"response":[],"_postman_id":"769f8f25-7063-4f31-8646-82fbd211b994"},{"name":"Get Unassigned Emails","id":"72da7fca-64ad-44f4-a2de-56b58afaf3a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/emails/unassigned/?orderby&limit&offset&bodylimit&content&subject&from","description":"

Gets Unassigned emails

How to sort the emails.

\n","type":"text/plain"},"key":"orderby","value":null},{"description":{"content":"

How many emails to return

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

What email to start with (for paging)

\n","type":"text/plain"},"key":"offset","value":null},{"description":{"content":"

How many characters of each emails body to return. Defaults to 150.

\n","type":"text/plain"},"key":"bodylimit","value":null},{"description":{"content":"

Text to search for in the email

\n","type":"text/plain"},"key":"content","value":null},{"description":{"content":"

Text to search for in the email subject line

\n","type":"text/plain"},"key":"subject","value":null},{"description":{"content":"

Text to search for in the from part of the email

\n","type":"text/plain"},"key":"from","value":null}],"variable":[]}},"response":[],"_postman_id":"72da7fca-64ad-44f4-a2de-56b58afaf3a1"},{"name":"Get Trashed Emails","id":"882483f4-2c9a-4b9f-9f13-acbc6053dc16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/emails/unassigned/?orderby&limit&offset&bodylimit&content&subject&from","description":"

Gets emails in the Trash

How to sort the emails.

\n","type":"text/plain"},"key":"orderby","value":null},{"description":{"content":"

How many emails to return

\n","type":"text/plain"},"key":"limit","value":null},{"description":{"content":"

What email to start with (for paging)

\n","type":"text/plain"},"key":"offset","value":null},{"description":{"content":"

How many characters of each emails body to return. Defaults to 150.

\n","type":"text/plain"},"key":"bodylimit","value":null},{"description":{"content":"

Text to search for in the email

\n","type":"text/plain"},"key":"content","value":null},{"description":{"content":"

Text to search for in the email subject line

\n","type":"text/plain"},"key":"subject","value":null},{"description":{"content":"

Text to search for in the from part of the email

\n","type":"text/plain"},"key":"from","value":null}],"variable":[]}},"response":[],"_postman_id":"882483f4-2c9a-4b9f-9f13-acbc6053dc16"},{"name":"Get an Email","id":"7ad42157-6c3f-4962-bf2e-8aebbb4bb5bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/emails/:emailId","description":"

Request a specific email

The Emails API endpoint allows you to search for matching emails or get an individual email.

If you want to send an email or reply by email, you'll need a case first and then you can reply to the case via email using the Cases API endpoint.

\n","event":[{"listen":"prerequest","script":{"id":"fcbe8354-2e4f-4ff2-a19f-7a6ff8da9c82","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ed043176-b14a-4ef7-8ed2-e954a5d1155f","type":"text/javascript","exec":[""]}}],"_postman_id":"bce26aad-4ec3-4ee4-9873-82d1a5b8bbd2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Reps (V2)","item":[{"name":"Get All Reps","id":"c90bfd4d-9356-4f30-926d-38df875f1fab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v2/reps/","description":"

Get all reps, both active and disabled

Request an individual rep full rep profile

Rep's User ID in FuseDesk

\n","type":"text/plain"},"type":"string","value":"","key":"userId"}]}},"response":[{"id":"02cefe39-7e8d-4136-939a-20b432838606","name":"Get a Rep (Not Found)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v2/reps/:userId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v2","reps",":userId"],"variable":[{"key":"userId","value":"17382"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Rep not found\",\n \"errorcode\": \"api_reps_notfound\"\n}"},{"id":"4469e7fe-34f8-424b-abcd-c0670bf19e45","name":"Get a Rep","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v2/reps/:userId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v2","reps",":userId"],"variable":[{"key":"userId","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"userId\": 2,\n \"firstName\": \"Kelly\",\n \"lastName\": \"Cafferty\",\n \"emailAddress\": \"jeremy-infusionsoftb@asandia.com\",\n \"signatureText\": \"Kelly\\nAccounting\",\n \"dateLastLogin\": \"2012-05-02T11:37:45-04:00\",\n \"dateDeactivated\": null,\n \"timeZone\": \"America/New_York\",\n \"defaultDepartmentId\": 268,\n \"avatarUrl\": \"https://secure.gravatar.com/avatar/d98f2df513e0fe91d24f9a63a11cd375?d=robohash\",\n \"crmUserId\": 2,\n \"active\": true,\n \"username\": \"kcx\",\n \"repid\": 433,\n \"signatureHtml\": \"Kelly
\\nAccounting\",\n \"isAdmin\": false,\n \"showCaseLog\": true,\n \"caseRestrict\": \"department\"\n}"}],"_postman_id":"dd2745a5-1205-4043-b00a-324d7aff1b4f"}],"id":"b21c1c8e-a4f5-44cb-acc5-ebde37e70971","description":"

The FuseDesk v2 API Endpoint for Reps allows you to do everything you need with FuseDesk Reps (aka Users or Team Members)

\n","_postman_id":"b21c1c8e-a4f5-44cb-acc5-ebde37e70971","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Contacts (V2)","item":[{"name":"Search Contacts","id":"77197b55-cc58-4087-b0da-c1f449292d8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v2/contacts/?search=","description":"

Search all of your FuseDesk (and if linked, CRM) contacts.

Text to search for

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"63882b60-b78c-48b9-bb84-147e679b6ac3","name":"Search Contacts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v2/contacts/?search=bob","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v2","contacts",""],"query":[{"key":"search","value":"bob","description":"Text to search for"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"0e6d4f95-d3c5-4912-8863-60daf1932a33\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Boberton\",\n \"emailAddress\": \"bob@boberton.bob\",\n \"emailAddress2\": \"\",\n \"emailAddress3\": \"\",\n \"phone1\": \"\",\n \"phoneExt1\": null,\n \"phone2\": \"\",\n \"phoneExt2\": null,\n \"timeZone\": \"\",\n \"website\": \"\",\n \"street1Billing\": \"\",\n \"street2Billing\": \"\",\n \"cityBilling\": \"\",\n \"stateBilling\": \"\",\n \"postalBilling\": \"\",\n \"countryBilling\": \"\",\n \"company\": \"\",\n \"dateCreated\": \"2020-05-13T17:05:01+00:00\",\n \"dateUpdated\": \"2020-05-13T17:05:02+00:00\",\n \"dateDeleted\": null,\n \"dateSynced\": null,\n \"createdBy\": 15,\n \"updatedBy\": 15,\n \"deletedBy\": null,\n \"crmId\": 1536\n },\n {\n \"id\": \"4a2ab1e7-216f-4b31-8320-ce2b44adbb97\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Tester\",\n \"emailAddress\": \"bobtestington@gmail.com\",\n \"emailAddress2\": \"\",\n \"emailAddress3\": \"\",\n \"phone1\": \"\",\n \"phoneExt1\": null,\n \"phone2\": \"\",\n \"phoneExt2\": null,\n \"timeZone\": \"\",\n \"website\": \"\",\n \"street1Billing\": \"\",\n \"street2Billing\": \"\",\n \"cityBilling\": \"\",\n \"stateBilling\": \"\",\n \"postalBilling\": \"\",\n \"countryBilling\": \"\",\n \"company\": \"FuseDesk Contact also in CRM\",\n \"dateCreated\": \"2020-02-06T20:57:27+00:00\",\n \"dateUpdated\": \"2020-02-10T17:12:14+00:00\",\n \"dateDeleted\": null,\n \"dateSynced\": \"2020-02-10T17:12:14+00:00\",\n \"createdBy\": 15,\n \"updatedBy\": 15,\n \"deletedBy\": null,\n \"crmId\": 1154\n },\n {\n \"firstName\": \"Bob\",\n \"lastName\": \"CRM Contact not in FuseDesk\",\n \"crmId\": 1490,\n \"emailAddress\": \"bobtest@test.test\",\n \"phone1\": \" \",\n \"company\": \"\",\n \"cityBilling\": \"\",\n \"stateBilling\": \"\",\n \"dateCreated\": \"2020-04-28T12:15:08+00:00\",\n \"id\": null\n }\n]"},{"id":"f22afdf4-df52-4327-adf2-65693f66a465","name":"Search Contacts (Error without a search query)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v2/contacts/?search","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v2","contacts",""],"query":[{"key":"search","value":null,"description":"Text to search for"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"X-FuseDesk-Error-Code","value":"api_contacts_missingid"},{"key":"X-FuseDesk-Error","value":"You must specify a Contact ID or Query"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"You must specify a Contact ID or Query\",\n \"errorcode\": \"api_contacts_missingid\"\n}"}],"_postman_id":"77197b55-cc58-4087-b0da-c1f449292d8f"},{"name":"Get a Contact","id":"bd3381b3-f9e7-47eb-a516-f30756c55473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v2/contacts/:contactId","description":"

Request a FuseDesk contact by UUID.

If the contact is linked to a contact in your CRM or a matching contact is found in your CRM, we'll merge in any CRM changes into the returned contact.

FuseDesk Contact's UUID

\n","type":"text/plain"},"type":"string","value":"","key":"contactId"}]}},"response":[],"_postman_id":"bd3381b3-f9e7-47eb-a516-f30756c55473"},{"name":"Update a Contact","id":"17df2743-b569-4e07-9e5a-85ce25bae6d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"firstName","value":"","type":"text","description":"

First Name

\n"},{"key":"lastName","value":"","type":"text","description":"

Last Name

\n"},{"key":"emailAddress","value":"","type":"text","description":"

Primary Email Address

\n"},{"key":"emailAddress2","value":"","type":"text","description":"

Secondary Email Address

\n"},{"key":"emailAddress3","value":"","type":"text","description":"

Tirtiary Email Address

\n"},{"key":"phone1","value":"","type":"text","description":"

Primary Phone Number

\n"},{"key":"phoneExt1","value":"","type":"text","description":"

Primary Phone Number Extension

\n"},{"key":"phone2","value":"","type":"text","description":"

Secondary Phone Number

\n"},{"key":"phoneExt2","value":"","type":"text","description":"

Secondary Phone Number Extension

\n"},{"key":"company","value":"","type":"text","description":"

Company / Business Name

\n"},{"key":"timeZone","value":"","type":"text","description":"

Time Zone

\n"},{"key":"website","value":"","type":"text","description":"

Website URL

\n"},{"key":"street1Billing","value":"","type":"text","description":"

Billing Address Street, Line 1

\n"},{"key":"street2Billing","value":"","type":"text","description":"

Billing Address Street, Line 2

\n"},{"key":"cityBilling","value":"","type":"text","description":"

Billing Address City

\n"},{"key":"stateBilling","value":"","type":"text","description":"

Billing Address State / Region

\n"},{"key":"postalBilling","value":"","type":"text","description":"

Billing Address Postal / Zip Code

\n"},{"key":"countryBilling","value":"","type":"text","description":"

Billing Address Country

\n"}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v2/contacts/:contactId","description":"

Update a FuseDesk contact. POST just the fields that you'd like to update.

If the contact is linked to a contact in your CRM or a matching contact is found in your CRM, we'll update the contact in your CRM, too.

FuseDesk Contact's UUID

\n","type":"text/plain"},"type":"string","value":"4a2ab1e7-216f-4b31-8320-ce2b44adbb97","key":"contactId"}]}},"response":[{"id":"bcf2666b-073c-4f89-bafd-b7104c126e31","name":"Update a Contact (Invalid ID)","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v2/contacts/:contactId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v2","contacts",":contactId"],"variable":[{"description":"FuseDesk Contact's UUID","key":"contactId","value":"sdfd"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"X-FuseDesk-Error-Code","value":"fdapp_error_invalidfield"},{"key":"X-FuseDesk-Error","value":"id is invalid"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"id is invalid\",\n \"errorcode\": \"fdapp_error_invalidfield\"\n}"},{"id":"f831f23b-5f4a-4cf2-a4af-4beff292457f","name":"Update a Contact","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"lastName","value":"Updated Last Name","type":"text"},{"key":"phone1","value":"508-555-1212","type":"text"}]},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v2/contacts/:contactId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v2","contacts",":contactId"],"variable":[{"description":"FuseDesk Contact's UUID","key":"contactId","value":"4a2ab1e7-216f-4b31-8320-ce2b44adbb97"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"4a2ab1e7-216f-4b31-8320-ce2b44adbb97\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Updated Last Name\",\n \"emailAddress\": \"fdsusietester@gmail.com\",\n \"emailAddress2\": \"\",\n \"emailAddress3\": \"\",\n \"phone1\": \"508-555-1212\",\n \"phoneExt1\": null,\n \"phone2\": \"\",\n \"phoneExt2\": null,\n \"timeZone\": \"\",\n \"website\": \"\",\n \"street1Billing\": \"\",\n \"street2Billing\": \"\",\n \"cityBilling\": \"\",\n \"stateBilling\": \"\",\n \"postalBilling\": \"\",\n \"countryBilling\": \"\",\n \"company\": \"\",\n \"dateCreated\": \"2020-02-06T20:57:27+00:00\",\n \"dateUpdated\": \"2020-05-27T21:34:59+00:00\",\n \"dateDeleted\": null,\n \"dateSynced\": \"2020-05-27T21:34:59+00:00\",\n \"createdBy\": 15,\n \"updatedBy\": 0,\n \"deletedBy\": null,\n \"crmId\": \"1154\",\n \"caseCountContact\": 1,\n \"caseCountCompany\": 0\n}"}],"_postman_id":"17df2743-b569-4e07-9e5a-85ce25bae6d4"},{"name":"Create a New Contact","id":"39b23fd9-d985-4daa-bc3e-ba60e20eee95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":"

First Name

\n","key":"firstName","type":"text","value":""},{"description":"

Last Name

\n","key":"lastName","type":"text","value":""},{"description":"

Primary Email Address

\n","key":"emailAddress","type":"text","value":""},{"description":"

Secondary Email Address

\n","key":"emailAddress2","type":"text","value":""},{"description":"

Tirtiary Email Address

\n","key":"emailAddress3","type":"text","value":""},{"description":"

Primary Phone Number

\n","key":"phone1","type":"text","value":""},{"description":"

Primary Phone Number Extension

\n","key":"phoneExt1","type":"text","value":""},{"description":"

Secondary Phone Number

\n","key":"phone2","type":"text","value":""},{"description":"

Secondary Phone Number Extension

\n","key":"phoneExt2","type":"text","value":""},{"description":"

Company / Business Name

\n","key":"company","type":"text","value":""},{"description":"

Time Zone

\n","key":"timeZone","type":"text","value":""},{"description":"

Website URL

\n","key":"website","type":"text","value":""},{"description":"

Billing Address Street, Line 1

\n","key":"street1Billing","type":"text","value":""},{"description":"

Billing Address Street, Line 2

\n","key":"street2Billing","type":"text","value":""},{"description":"

Billing Address City

\n","key":"cityBilling","type":"text","value":""},{"description":"

Billing Address State / Region

\n","key":"stateBilling","type":"text","value":""},{"description":"

Billing Address Postal / Zip Code

\n","key":"postalBilling","type":"text","value":""},{"description":"

Billing Address Country

\n","key":"countryBilling","type":"text","value":""}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v2/contacts/","description":"

Create a FuseDesk contact. POST just the fields that you need.

If a matching contact is found in your CRM, we'll link up the contacts. If not, we'll create the contact in your CRM, too.

The Contacts API Endpoint allows you to work with FuseDesk contacts - and if you're CRM is connected, your CRM contacts, too!

\n","event":[{"listen":"prerequest","script":{"id":"3d40dcb8-de2c-46bc-b737-d44fb117bc61","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ff9b7ae3-af76-4d07-a3fd-a84a52f46341","type":"text/javascript","exec":[""]}}],"_postman_id":"f0c4ce87-1db4-4bfd-8934-6862735b9834","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Case Tags","item":[{"name":"Get Case Tags","id":"11e964aa-3203-4a83-92cb-42c79a682380","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/casetags/","description":"

Get all of your Case Tags

The name of your new tag

\n","type":"text"}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/casetags/","description":"

Create a new Case Tag in FuseDesk.

Deleting a Case Tag Archives it.

Case Tags in FuseDesk allow you to organize your cases, making them easier to find and track. Case Tags allow you to trigger FuseDesk Automations.

If you'd like to apply case tags to or remove case tags from a case, use the Cases API Endpoint.

\n","event":[{"listen":"prerequest","script":{"id":"a9c24f8d-e290-48e7-a00d-a614b7641a50","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"324e2a1f-c0ac-46a7-8e52-0527e7f72f16","type":"text/javascript","exec":[""]}}],"_postman_id":"019d466a-3ee7-444c-b703-0941bfbd2506","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Departments (V1)","item":[{"name":"Get All Active Departments","id":"20007400-d451-40a1-aff2-2ce376a86771","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/departments/","description":"

Get a list of all active departments in your FuseDesk app.

Get all departments, including archived departments.

The name of your new department

\n","key":"name","type":"text","value":""}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/departments/","description":"

Create a Department in FuseDesk.

Get a Department in FuseDesk.

Array or CSV of the rep IDs you want in the department. Set to * for All Current and Future Reps

\n","key":"reps","type":"text","value":""},{"description":"

The FuseDesk Email Template ID (int) to use as the default reply template

\n","key":"replytemplate","type":"text","value":""},{"description":"

The FuseDesk Email Template category (string) to use by default.

\n","key":"templatecategory","type":"text","value":""},{"description":"

How many hours (int) to wait before a case goes from green to yellow

\n","key":"stalewarning","type":"text","value":""},{"description":"

How many hours (int) to wait before a case goes from yellow to red

\n","key":"stale","type":"text","value":""},{"description":"

How many days (int) to wait after a case is closed before asking for feedback

\n","key":"feedbackdelay","type":"text","value":""},{"description":"

The FuseDesk Email Template ID (int) to send when asking for feedback

\n","key":"feedbacktemplate","type":"text","value":""},{"description":"

What percent of cases (int, 0-100) to request feedback on

\n","key":"feedbacksample","type":"text","value":""}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/departments/:departmentId","description":"

Send in just the fields you'd like to update.

Note that departments can not be renamed after they are created.

This is the legacy v1 version of our Departments API endpoint. It is still supported but you should ideally use our newer v2 API endpoint.

Use the departments API endpoint to create, update, and get info on all or one department.

\n","event":[{"listen":"prerequest","script":{"id":"dc2bae3b-7751-4085-8419-d99d0edec808","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a549a8a7-8252-4ff7-80a8-3d5547572d9b","type":"text/javascript","exec":[""]}}],"_postman_id":"736fd528-5c31-4397-8a07-951625ae353a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Departments (V2)","item":[{"name":"Get All Active Departments","id":"0c956f60-09e1-4cce-9a74-8ed477a786e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v2/departments/","description":"

Get a list of all active departments in FuseDesk.

Request a list of all departments that have been archived.

Get all departments, including archived departments.

The name of your new department

\n","key":"name","type":"text","value":""}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v2/departments/","description":"

Create a Department in FuseDesk.

Get a Department in FuseDesk.

Boolean if this department should include all current and future reps

\n","type":"text"},{"description":"

Array or CSV of the rep IDs you want in the department.

\n","key":"repUserIds","type":"text","value":""},{"description":"

The FuseDesk Email Template ID (int) to use as the default reply template

\n","key":"replyTemplateId","type":"text","value":""},{"description":"

The FuseDesk Email Template category (string) to use by default.

\n","key":"templateCategory","type":"text","value":""},{"description":"

How many hours (int) to wait before a case goes from yellow to red

\n","key":"stale","type":"text","value":""},{"description":"

How many hours (int) to wait before a case goes from green to yellow

\n","key":"staleWarning","type":"text","value":""},{"description":"

How many days (int) to wait after a case is closed before asking for feedback

\n","key":"feedbackDelay","type":"text","value":""},{"description":"

The FuseDesk Email Template ID (int) to send when asking for feedback

\n","key":"feedbackTemplateId","type":"text","value":""},{"description":"

What percent of cases (int, 0-100) to request feedback on

\n","key":"feedbackSample","type":"text","value":""},{"key":"feedbackFrequency","value":"","description":"

How many days to wait before asking a contact for feedback again.

\n","type":"text"}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v2/departments/:departmentId","description":"

Send in just the fields you'd like to update.

Note that departments can not be renamed after they are created.

Archive a Department in FuseDesk.

Restore an Archived Department in FuseDesk.

Use the departments API endpoint to create, update, and get info on all or one department.

\n","event":[{"listen":"prerequest","script":{"id":"ac1ab4de-9057-4821-9fb7-bab8f39919e4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"28f967e6-19dc-4909-b9fa-0409f7f123ef","type":"text/javascript","exec":[""]}}],"_postman_id":"3f9d88d4-6172-4521-a35f-88ae0eab19a4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Get All Webhooks","id":"e9fb9adb-726f-4af1-9f77-ad06f344c82a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v2/webhooks/","description":"

Get a list of all Webhooks in FuseDesk.

Object Type can be one of case, contact, rep, or department.

\n","type":"text"},{"key":"action","value":"","description":"

Action can be generally one of create or update. Cases also support status, close, and transfer

\n","type":"text"},{"key":"url","value":"","description":"

A valid URL for us to POST to

\n","type":"text"}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v2/webhooks/","description":"

Create a Webhook in FuseDesk.

Delete a Webhook in FuseDesk.

The ID of the Webhook you'd like to delete

\n","type":"text/plain"},"type":"any","value":"","key":"webhookId"}]}},"response":[],"_postman_id":"35aa02a4-9eaa-4194-a092-32959f5462e5"}],"id":"387b2633-dae5-4977-a220-860584999f96","description":"

FuseDesk's Webhooks allow you to \"subscribe\" to certain actions on objects.

For example, you can ask FuseDesk to POST to your webhook endpoint when a case is resolved, a rep is added, a contact is updated, and more.

To create a new webhook, you'll need an objectType, an action, and a valid url for FuseDesk to POST to.

Assuming your URL is valid, FuseDesk will then send the requested object to your URL when the requested action happens.

Your URL must be responsive, i.e. respond in under 2 seconds (ideally under 500ms).

If your URL responds with an HTTP Status Code of 404 (\"Not Found\") or a 414 (\"Delete This Subscription\"), FuseDesk will automatically delete your webhook.

FuseDesk will post rich headers and a JSON encoded object to your URL.

Headers of interest include x-fusedesk-queued-item-id, x-fusedesk-webhook-id, x-fusedesk-object-type, and x-fusedesk-action.

The POST will include a JSON object with the following fields of note:

id the queued item Id
appName the name of your FuseDesk app
authMethod the authentication method that initiated this request. Could be one of many things, but is typically user or apikey
timestamp the current microtime on the POSTing server
eventTime the time that the object was queued to be POSTed
objectType the type of object
action the type of action
payload the actual object which varies by object type

\n","_postman_id":"387b2633-dae5-4977-a220-860584999f96","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}},{"name":"Chats","item":[{"name":"List Chats","id":"28be6359-388d-4743-8d2c-f0009cb627ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/chats/","description":"

To get a list of all active chats, simply GET the /api/v1/chats/ API endpoint.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","chats",""],"host":["YOURAPPNAME","fusedesk","com"],"query":[],"variable":[]}},"response":[{"id":"cf0c8a36-ec05-4165-8cce-eaa3dacb5f0b","name":"List Chats","originalRequest":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/chats/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"dateCreated\": \"2020-06-10T19:16:18+00:00\",\n \"title\": \"Thanks for the giftie!\",\n \"repId\": 15,\n \"contactId\": 1692,\n \"contactUuid\": \"28c725f8-4e97-44fa-a4b7-4680eef3c09a\",\n \"caseId\": 738553,\n \"noteId\": 2199626,\n \"platform\": \"twilio\",\n \"platformId\": null,\n \"integrationId\": \"0e1eacba-b51f-11e8-bb27-0cc47a4c6790\",\n \"clientName\": \"Bob Tester\",\n \"dateClosed\": null,\n \"dateAnonymized\": null,\n \"lastMessage\": \"Thank you so much for sending me the free gift! You guys are the best! ❤️\",\n \"dateLastMessage\": \"2020-06-10T20:10:34+00:00\",\n \"dateLastMessageReceived\": \"2020-06-10T20:10:34+00:00\",\n \"lastMessageSender\": \"Tracy Duncan\",\n \"dateLastResponse\": \"2020-06-10T20:10:34+00:00\",\n \"dateBlocked\": null,\n \"unseen\": 0,\n \"departmentId\": 273,\n \"meta\": {},\n \"isArchived\": false,\n \"isAnonymized\": false,\n \"avatarUrl\": \"https://secure.gravatar.com/avatar/245b0f1ad16c25309a52ed182aa38cf4?d=robohash\"\n },\n {\n \"id\": \"14c262bd-1bb4-41a2-b511-9971b2895eef\",\n \"dateCreated\": \"2021-02-10T19:15:32+00:00\",\n \"title\": \"SMS with Amanda\",\n \"repId\": 25,\n \"contactId\": 546,\n \"contactUuid\": \"382369f5-d039-4b86-9722-ce16ab02cf29\",\n \"caseId\": 738481,\n \"noteId\": null,\n \"platform\": \"fyf\",\n \"platformId\": \"+5329184849273\",\n \"integrationId\": \"26b12cc1-8b7b-11e8-b7b1-0cc47a4c6790\",\n \"clientName\": \"Amanda Tester\",\n \"dateClosed\": null,\n \"dateAnonymized\": null,\n \"lastMessage\": \"I love FuseDesk!\",\n \"dateLastMessage\": \"2021-11-09T01:52:51+00:00\",\n \"dateLastMessageReceived\": \"2021-11-09T01:52:51+00:00\",\n \"lastMessageSender\": \"Charlie Testing\",\n \"dateLastResponse\": \"2021-11-09T01:52:51+00:00\",\n \"dateBlocked\": null,\n \"unseen\": 0,\n \"departmentId\": 273,\n \"meta\": {\n \"ourNumber\": \"+16504801234\",\n \"fyfNumberId\": 14034,\n \"clientEmail\": \"amandatester@example.com\"\n },\n \"isArchived\": false,\n \"isAnonymized\": false,\n \"avatarUrl\": \"https://secure.gravatar.com/avatar/6fc6b6c9a6a2038dc4937371a1310c22?d=robohash\"\n },\n {\n \"id\": \"66a8b4f9-e3d9-4cc8-8cd5-312893a2dd17\",\n \"dateCreated\": \"2022-07-27T21:25:06+00:00\",\n \"title\": \"Chat from mywebsiteexample.com\",\n \"repId\": 15,\n \"contactId\": 1702,\n \"contactUuid\": \"7b23c3bf-d82c-4456-8ffc-96689bc76d4b\",\n \"caseId\": null,\n \"noteId\": null,\n \"platform\": \"livechat\",\n \"platformId\": null,\n \"integrationId\": \"0e1eacba-b51f-11e8-bb27-0cc47a4c6790\",\n \"clientName\": \"Suzie A Tester\",\n \"dateClosed\": null,\n \"dateAnonymized\": null,\n \"lastMessage\": \"Hey there!!!\",\n \"dateLastMessage\": \"2022-07-27T21:26:59+00:00\",\n \"dateLastMessageReceived\": \"2022-07-27T21:26:59+00:00\",\n \"lastMessageSender\": \"Suzie A Tester\",\n \"dateLastResponse\": \"2022-07-27T21:26:59+00:00\",\n \"dateBlocked\": null,\n \"unseen\": 0,\n \"departmentId\": 587,\n \"meta\": {\n \"timezoneOffset\": 240,\n \"timezoneName\": \"America/Santo_Domingo\",\n \"languages\": [\n \"en-US\"\n ],\n \"userAgent\": \"Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1\",\n \"platform\": \"iPhone\",\n \"screen\": {\n \"height\": 926,\n \"width\": 428\n },\n \"entryPage\": \"https://mywebsiteexample.com/\",\n \"entryPageTitle\": \"My Website Example WElcome\",\n \"utm\": [],\n \"clientName\": \"Suzie A Tester\",\n \"clientEmail\": \"suzietester@example.com\",\n \"custom\": {\n \"membershipLevel\": \"Silver\"\n },\n \"ipAddress\": \"123.143.13.21\",\n \"ipGeoLocation\": {\n \"countryCode\": \"DO\",\n \"countryName\": \"Dominican Republic\",\n \"regionCode\": \"32\",\n \"regionName\": \"Santo Domingo\",\n \"city\": \"Santo Domingo Oeste\",\n \"countryFlagEmoji\": \"🇩🇴\"\n }\n },\n \"isArchived\": false,\n \"isAnonymized\": false,\n \"avatarUrl\": \"https://secure.gravatar.com/avatar/8bf16a3dae0e7f930d584c9e2f4475af?d=robohash\"\n }\n]"}],"_postman_id":"28be6359-388d-4743-8d2c-f0009cb627ac"},{"name":"Get a Chat","id":"b5ca8abc-a274-4bae-9ca3-f04735e0fe72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOURAPPNAME.fusedesk.com/api/v1/chats/:chatId","description":"

Ready to get an individual chat with all of it's message history?

The ID of the Chat you'd like

\n","type":"text/plain"},"type":"any","value":null,"key":"chatId"}]}},"response":[{"id":"056c64b9-65fc-4f83-846b-71e62ef85e4b","name":"Get a Chat","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/chats/:chatId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","chats",":chatId"],"variable":[{"key":"chatId","value":"","description":"The ID of the Chat you'd like"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"dateCreated\": \"2020-06-10T19:16:18+00:00\",\n \"title\": \"Thanks for the giftie!\",\n \"repId\": 15,\n \"contactId\": 1692,\n \"contactUuid\": \"28c725f8-4e97-44fa-a4b7-4680eef3c09a\",\n \"caseId\": 738553,\n \"noteId\": 2199626,\n \"platform\": \"twilio\",\n \"platformId\": null,\n \"integrationId\": \"0e1eacba-b51f-11e8-bb27-0cc47a4c6790\",\n \"clientName\": \"Bob Tester\",\n \"dateClosed\": null,\n \"dateAnonymized\": null,\n \"lastMessage\": \"Thank you so much for sending me the free gift! You guys are the best! ❤️\",\n \"dateLastMessage\": \"2020-06-10T20:10:34+00:00\",\n \"dateLastMessageReceived\": \"2020-06-10T20:10:34+00:00\",\n \"lastMessageSender\": \"Tracy Duncan\",\n \"dateLastResponse\": \"2020-06-10T20:10:34+00:00\",\n \"dateBlocked\": null,\n \"unseen\": 0,\n \"departmentId\": 273,\n \"meta\": {},\n \"isArchived\": false,\n \"isAnonymized\": false,\n \"avatarUrl\": \"https://secure.gravatar.com/avatar/245b0f1ad16c25309a52ed182aa38cf4?d=robohash\",\n \"messages\": [\n {\n \"id\": \"110406a5-577a-42db-9d0c-f8bd3b52d4e5\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": null,\n \"dateSent\": \"2020-06-10T19:16:18.000000+00:00\",\n \"senderName\": \"Tracy Duncan\",\n \"message\": \"Hey\",\n \"meta\": null,\n \"platformId\": null\n },\n {\n \"id\": \"f9775680-dd9f-478d-9579-7962f8278a29\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T19:16:25.000000+00:00\",\n \"senderName\": \"Suzie A Tester\",\n \"message\": \"Hey\",\n \"meta\": null,\n \"platformId\": null\n },\n {\n \"id\": \"08cb28c8-1979-4317-a1cc-ba219397f296\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T19:16:25.000000+00:00\",\n \"senderName\": null,\n \"message\": null,\n \"meta\": {\n \"eventType\": \"chatAssign\",\n \"assigningRepId\": 15,\n \"repId\": 15,\n \"departmentId\": null\n },\n \"platformId\": null\n },\n {\n \"id\": \"43a2b4ae-a02f-4482-b3d3-cc981bf13a93\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T20:10:20.000000+00:00\",\n \"senderName\": \"Suzie A Tester\",\n \"message\": \"You're welcome!\",\n \"meta\": null,\n \"platformId\": null\n }\n ]\n}"}],"_postman_id":"b5ca8abc-a274-4bae-9ca3-f04735e0fe72"},{"name":"Update a Chat","id":"04842f72-4833-46c1-bd1a-b4213a0e008d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"","type":"text","description":"

To rename a chat

\n"},{"key":"repId","value":"","type":"text","description":"

The ID of the rep to transfer the chat to

\n"},{"key":"departmentId","value":"","type":"text","description":"

The ID of the department to transfer the chat to

\n"},{"key":"contactUuid","value":"","type":"text","description":"

The UUID of the Contact to relink the chat to a different contact

\n"},{"key":"clientName","value":"","type":"text","description":"

The name of the client you're chatting with if you'd like to rename

\n"},{"key":"caseId","value":"","type":"text","description":"

The ID of the case to link the chat to

\n"},{"key":"unseen","value":"","type":"text","description":"

The number of \"unseen\" messages by the rep, i.e. 0 to mark all messages as seen

\n"}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/chats/:chatId","description":"

Want to update a chat? Simply POST to it with the changes you'd like to make.

The ID of the Chat you'd like

\n","type":"text/plain"},"type":"any","value":null,"key":"chatId"}]}},"response":[{"id":"dcc43c11-1b69-4c0a-9cb3-44d8fcad10e0","name":"Updated Chat","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Thanks for the giftie!\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/chats/:chatId","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","chats",":chatId"],"variable":[{"key":"chatId","value":"","description":"The ID of the Chat you'd like"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"dateCreated\": \"2020-06-10T19:16:18+00:00\",\n \"title\": \"Thanks for the giftie!\",\n \"repId\": 15,\n \"contactId\": 1692,\n \"contactUuid\": \"28c725f8-4e97-44fa-a4b7-4680eef3c09a\",\n \"caseId\": 738553,\n \"noteId\": 2199626,\n \"platform\": \"twilio\",\n \"platformId\": null,\n \"integrationId\": \"0e1eacba-b51f-11e8-bb27-0cc47a4c6790\",\n \"clientName\": \"Bob Tester\",\n \"dateClosed\": null,\n \"dateAnonymized\": null,\n \"lastMessage\": \"Thank you so much for sending me the free gift! You guys are the best! ❤️\",\n \"dateLastMessage\": \"2020-06-10T20:10:34+00:00\",\n \"dateLastMessageReceived\": \"2020-06-10T20:10:34+00:00\",\n \"lastMessageSender\": \"Tracy Duncan\",\n \"dateLastResponse\": \"2020-06-10T20:10:34+00:00\",\n \"dateBlocked\": null,\n \"unseen\": 0,\n \"departmentId\": 273,\n \"meta\": {},\n \"isArchived\": false,\n \"isAnonymized\": false,\n \"avatarUrl\": \"https://secure.gravatar.com/avatar/245b0f1ad16c25309a52ed182aa38cf4?d=robohash\",\n \"messages\": [\n {\n \"id\": \"110406a5-577a-42db-9d0c-f8bd3b52d4e5\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": null,\n \"dateSent\": \"2020-06-10T19:16:18.000000+00:00\",\n \"senderName\": \"Tracy Duncan\",\n \"message\": \"Hey\",\n \"meta\": null,\n \"platformId\": null\n },\n {\n \"id\": \"f9775680-dd9f-478d-9579-7962f8278a29\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T19:16:25.000000+00:00\",\n \"senderName\": \"Suzie A Tester\",\n \"message\": \"Hey\",\n \"meta\": null,\n \"platformId\": null\n },\n {\n \"id\": \"08cb28c8-1979-4317-a1cc-ba219397f296\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T19:16:25.000000+00:00\",\n \"senderName\": null,\n \"message\": null,\n \"meta\": {\n \"eventType\": \"chatAssign\",\n \"assigningRepId\": 15,\n \"repId\": 15,\n \"departmentId\": null\n },\n \"platformId\": null\n },\n {\n \"id\": \"43a2b4ae-a02f-4482-b3d3-cc981bf13a93\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T20:10:20.000000+00:00\",\n \"senderName\": \"Suzie A Tester\",\n \"message\": \"You're welcome!\",\n \"meta\": null,\n \"platformId\": null\n }\n ]\n}"}],"_postman_id":"04842f72-4833-46c1-bd1a-b4213a0e008d"},{"name":"Close (Resolve) a Chat","id":"fda44692-6a99-4b38-8d98-408bdbeca27f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"repid","value":"","type":"text","description":"

Optional, to create a case, the ID of the rep to assign the case to

\n"},{"key":"depid","value":"","type":"text","description":"

Optional, to create a case, the ID of the department to assign the case to

\n"},{"key":"status","value":"","type":"text","description":"

Optional, if creating a case, the status of the new case, one of new (default), open, or closed.

\n"}]},"url":"https://YOURAPPNAME.fusedesk.com/api/v1/chats/:chatId/close","description":"

Want to update a chat? Simply POST to it with the changes you'd like to make.

The ID of the Chat you'd like to close

\n","type":"text/plain"},"type":"any","value":null,"key":"chatId"}]}},"response":[{"id":"e8b0080d-c3b7-4868-96a8-c39986eb6a4c","name":"Close a Chat","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"repid\": 15,\n \"status\": \"closed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://YOURAPPNAME.fusedesk.com/api/v1/chats/:chatId/close","protocol":"https","host":["YOURAPPNAME","fusedesk","com"],"path":["api","v1","chats",":chatId","close"],"variable":[{"key":"chatId","value":"","description":"The ID of the Chat you'd like"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"dateCreated\": \"2020-06-10T19:16:18+00:00\",\n \"title\": \"Thanks for the giftie!\",\n \"repId\": 15,\n \"contactId\": 1692,\n \"contactUuid\": \"28c725f8-4e97-44fa-a4b7-4680eef3c09a\",\n \"caseId\": 738553,\n \"noteId\": 2199626,\n \"platform\": \"twilio\",\n \"platformId\": null,\n \"integrationId\": \"0e1eacba-b51f-11e8-bb27-0cc47a4c6790\",\n \"clientName\": \"Bob Tester\",\n \"dateClosed\": \"2021-06-10T20:10:34+00:00\",,\n \"dateAnonymized\": null,\n \"lastMessage\": \"Thank you so much for sending me the free gift! You guys are the best! ❤️\",\n \"dateLastMessage\": \"2020-06-10T20:10:34+00:00\",\n \"dateLastMessageReceived\": \"2020-06-10T20:10:34+00:00\",\n \"lastMessageSender\": \"Tracy Duncan\",\n \"dateLastResponse\": \"2020-06-10T20:10:34+00:00\",\n \"dateBlocked\": null,\n \"unseen\": 0,\n \"departmentId\": 273,\n \"meta\": {},\n \"isArchived\": false,\n \"isAnonymized\": false,\n \"avatarUrl\": \"https://secure.gravatar.com/avatar/245b0f1ad16c25309a52ed182aa38cf4?d=robohash\",\n \"messages\": [\n {\n \"id\": \"110406a5-577a-42db-9d0c-f8bd3b52d4e5\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": null,\n \"dateSent\": \"2020-06-10T19:16:18.000000+00:00\",\n \"senderName\": \"Tracy Duncan\",\n \"message\": \"Hey\",\n \"meta\": null,\n \"platformId\": null\n },\n {\n \"id\": \"f9775680-dd9f-478d-9579-7962f8278a29\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T19:16:25.000000+00:00\",\n \"senderName\": \"Suzie A Tester\",\n \"message\": \"Hey\",\n \"meta\": null,\n \"platformId\": null\n },\n {\n \"id\": \"08cb28c8-1979-4317-a1cc-ba219397f296\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T19:16:25.000000+00:00\",\n \"senderName\": null,\n \"message\": null,\n \"meta\": {\n \"eventType\": \"chatAssign\",\n \"assigningRepId\": 15,\n \"repId\": 15,\n \"departmentId\": null\n },\n \"platformId\": null\n },\n {\n \"id\": \"43a2b4ae-a02f-4482-b3d3-cc981bf13a93\",\n \"chatId\": \"08a8b424-b45a-458b-97c1-419db148d1b8\",\n \"repId\": 15,\n \"dateSent\": \"2020-06-10T20:10:20.000000+00:00\",\n \"senderName\": \"Suzie A Tester\",\n \"message\": \"You're welcome!\",\n \"meta\": null,\n \"platformId\": null\n }\n ]\n}"}],"_postman_id":"fda44692-6a99-4b38-8d98-408bdbeca27f"}],"id":"0c5ccb1a-087c-437c-bcb2-962907811fcc","description":"

Our Chats API endpoint allows you to list, get, respond to, update, and create chats across all of our chat platforms.

\n","_postman_id":"0c5ccb1a-087c-437c-bcb2-962907811fcc","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]},"isInherited":true,"source":{"_postman_id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","id":"1d9d7b71-b4bb-4365-9fd6-db9ae4cda280","name":"FuseDesk API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-FuseDesk-Api-Key"},{"key":"value","value":"YOURAPIKEY"}]}},"event":[{"listen":"prerequest","script":{"id":"dd0f1384-d754-4f76-a4c4-ed7cb36cbca1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1e84d3ac-9f6d-42fa-9327-ebbe9faf4153","type":"text/javascript","exec":[""]}}],"variable":[{"key":"AppName","value":"YOURAPPNAME"},{"key":"ApiKey","value":"YOURAPIKEY"}]}

Error Reporting

HTTP Status Codes

Rate Limiting

Data Formats

API Key Permissions/Scope

Authenticating via the API

Authenticating via HTTP Headers

Authenticating via Query Parameter

Authenticating as a User with a Cookie

Authenticating with a JWT Bearer Token

Failed Authentication