Update profile
PATCH {{baseUrl}}/api/v1/profiles/:profile_id
This API updates the details of an existing profile.
OAuth Scope
Desk.settings.UPDATE
Desk.basic.UPDATE
Attributes
Attribute Name | Data Type | Description |
---|---|---|
name | <string> max chars : 50 | Name of the profile |
description | <string> max chars : 3200 | Description of the profile |
permissions | <object> | Details of the permissions for the profile |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"default":true,"permissions":{"crmInteg":{"crmContactsActivityEvents":false,"crmAccountsActivityEvents":false,"crmAccountsActivityTasks":false,"crmAccountsInfo":false,"crmContactsActivityCalls":false,"crmAccountsNotes":false,"crmAccountsActivityCalls":false,"crmContactsInfo":false,"crmContactsNotes":false,"crmContactsActivityTasks":false,"crmAccountsPotentials":false,"crmContactsPotentials":false},"reports":{"view":true,"edit":true,"create":false,"delete":false,"export":false},"tickets":{"mergeTickets":true,"changeOwner":true,"import":true,"handleUnassigned":true,"edit":true,"closeTicket":true,"mailReview":true,"delete":true,"view":true,"create":true,"addFollowers":true,"export":true,"mailSend":true,"unassignedChangeOwner":false,"shareTickets":false},"comments":{"edit":true,"delete":true},"social":{"view":true},"contracts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"community":{"view":true,"edit":true,"create":true,"delete":true,"moderate":false},"products":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"agents":{"overview":true,"import":true,"edit":false,"create":false,"delete":false,"viewAllFields":true},"kbCategory":{"view":true,"editAllArticles":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"setup":{"timeTracking":false,"fetchAcrossDepartment":true,"globalReports":false,"exportPortalUsers":true,"layouts":false,"automation":false,"featureConfig":false,"customerHappiness":false,"department":false,"portal":false,"webForm":false,"rebranding":false,"email":false,"tabsAndFields":false,"exportUsers":true,"teams":true,"social":false,"templates":false,"moveRecords":true,"permission":false,"signUpApproval":false,"community":false,"importHistory":true,"manageAgents":false,"portalUsers":false,"managerDashboard":false,"googleAnalytics":false,"chat":false,"telephony":false},"financeInteg":{"sendInvoice":false,"createEstimate":false,"createContact":false,"viewInvoice":false,"createInvoice":false,"sendEstimate":false,"viewEstimate":false},"accounts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"timeEntry":{"view":true,"edit":true,"create":true,"delete":true},"contacts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"tasks":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true}},"name":"Agent Advisors","description":"Advisors from CRM to assist the Support Agents.","id":"4000000018001","isVisible":true,"type":"Custom"}