POST /api/v2/custom_objects/{custom_object_key}/access_rules
Creates a new access rule for a custom object. Access rules define conditions that restrict which records a role can access based on field values or relationships.
Allowed For
- Admins
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
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 |
|---|---|---|---|
access_rule |
Object | No | |
access_rule.description |
String | No |
A description of what this access rule does |
access_rule.conditions |
Object | No |
The conditions that define when this rule applies |
access_rule.conditions.any[] |
Array | No |
Any condition can be true (OR logic) |
access_rule.conditions.any[].field |
String | No |
The field to evaluate in the condition |
access_rule.conditions.any[].operator |
String | No |
The comparison operator to use. Not all field types support all operators. Valid values:
|
access_rule.conditions.any[].value |
No |
The value to compare against. Can be null for terminal operators like 'present' and 'not_present' |
|
access_rule.conditions.all[] |
Array | No |
All conditions must be true (AND logic) |
access_rule.conditions.all[].field |
String | No |
The field to evaluate in the condition |
access_rule.conditions.all[].operator |
String | No |
The comparison operator to use. Not all field types support all operators. Valid values:
|
access_rule.conditions.all[].value |
No |
The value to compare against. Can be null for terminal operators like 'present' and 'not_present' |
|
access_rule.title |
String | No |
The title of the access rule |
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.