Set access configuration for a cost center

put

https://api.perk.com/cost_centers/{id}/access

Updates the access configuration (access_type, user_ids, group_ids) for the cost center.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Note
For more information on managing access in cost objects see this link.

Path Params

string

required

The unique ID of the cost center

Body Params

access_type

string

enum

required

The access type for the cost center. 'all' grants access to all users; 'specificUsers' restricts access to the listed 'user_ids'; 'specificUsersOrUserGroups' restricts access to the listed 'user_ids' and/or 'group_ids'.

Allowed:

group_ids

array of strings

The IDs of the user groups granted access to the cost center. Each group must exist within the account and be active. Must be empty when 'all' or 'specificUsers' 'access_type' is used. At least one of 'user_ids' or 'group_ids' is required when 'specificUsersOrUserGroups' is used.

group_ids

user_ids

array of integers

The IDs of the users granted access to the cost center. Must be positive integers. Must be empty when 'access_type' is 'all'. Required when 'access_type' is 'specificUsers' is used. At least one of 'user_ids' or 'group_ids' is required when 'specificUsersOrUserGroups' is used.

user_ids

Headers

Authorization

string

required

Your Perk API key

Responses

Note

200Returns '200 OK' and the updated cost center resource with the new access configuration.

400Returns '400 Bad Request' when the request body is invalid.