Skip to main content

Update a Permission

Update a permission given their permissionId.


This endpoint has been deprecated and will be phased out at the end of 2023. Please update any existing usages of it to use the Update Object endpoint instead.


PUT /v1/permissions/:permissionId


permissionIdThe id of the permission to update. Note that id cannot be changed.URL paramyes
nameAn optional, display-friendly name for the permission.JSON bodyno
descriptionAn optional description of the permission. A useful description might include a summary of the functionality the permission grants.JSON bodyno

Note: Optional fields that are omitted will clear existing values.


curl "" \
-X PUT \
-H "Authorization: ApiKey YOUR_KEY" \
--data-raw \
'{ "name": "View Contact Info", description: "Grant user access to view customer contact info" }'


"permissionId": "view-contact-info",
"name": "View Contact Info",
"description": "Grant user access to view customer contact info"