PATCH /api/v2/custom_objects/{custom_object_key}/permission_policies/{id}

Updates a permission policy for a specific role on a custom object. Define what actions (create, read, update, delete) the role can perform and optionally specify access rules.

Allowed For

Admins

Servers

https://{subdomain}.{domain}.com

Path parameters

Name	Type	Required	Description
`id`	String	Yes	The permission policy ID. Use `custom-role-{custom_role_id}` for custom roles or `end-user` for the end user system role.
`custom_object_key`	String	Yes	The key of a custom object

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`policy`	Object	No
`policy.records`	Object	No	Permission settings for different record operations
`policy.records.create`	Object	No
`policy.records.create.allowed`	Boolean	No	Whether this action is allowed for the role
`policy.records.create.rule_id`	Integer	No	Optional access rule ID that further restricts this permission. Use null when no rule applies.
`policy.records.delete`	Object	No
`policy.records.delete.allowed`	Boolean	No	Whether this action is allowed for the role
`policy.records.delete.rule_id`	Integer	No	Optional access rule ID that further restricts this permission. Use null when no rule applies.
`policy.records.read`	Object	No
`policy.records.read.allowed`	Boolean	No	Whether this action is allowed for the role
`policy.records.read.rule_id`	Integer	No	Optional access rule ID that further restricts this permission. Use null when no rule applies.
`policy.records.update`	Object	No
`policy.records.update.allowed`	Boolean	No	Whether this action is allowed for the role
`policy.records.update.rule_id`	Integer	No	Optional access rule ID that further restricts this permission. Use null when no rule applies.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.