Create a new role

POST

https://api.close.com/api/v1/role/

`visibility_user_lcf_ids` (optional) A list of Lead Custom Field IDs that define which leads user with this role can see. If the role has `view_all_leads` permission, this field should be empty. `visibility_user_lcf_behavior` (optional) Defines how lead visibility works for leads that don't have assigned users. If the role has `view_all_leads` permission, this field should be empty. - `require_assignment` - leads without assigned users are not visible to this role - `allow_unassigned` - leads without assigned users are visible to this role

visibility_user_lcf_ids (optional)

A list of Lead Custom Field IDs that define which leads user with this role can see. If the role has view_all_leads permission, this field should be empty.

visibility_user_lcf_behavior (optional)

Defines how lead visibility works for leads that don’t have assigned users. If the role has view_all_leads permission, this field should be empty.

require_assignment - leads without assigned users are not visible to this role
allow_unassigned - leads without assigned users are visible to this role

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects any.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X POST https://api.close.com/api/v1/role/ \
>	-H "Content-Type: application/json" \
>	-u "<CLOSE_API_KEY>:" \
>	-d '{
>	"name": "Account Manager",
>	"permissions": [
>	"bulk_edit",
>	"export"
>	],
>	"visibility_user_lcf_behavior": null,
>	"visibility_user_lcf_ids": null
>	}'

1	{
2	"editable": true,
3	"id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
4	"name": "Account Manager",
5	"permissions": [
6	"bulk_edit",
7	"export"
8	],
9	"visibility_user_lcf_behavior": null,
10	"visibility_user_lcf_ids": null
11	}

$	curl -X POST https://api.close.com/api/v1/role/ \
>	-H "Content-Type: application/json" \
>	-u "<CLOSE_API_KEY>:" \
>	-d '{
>	"name": "Account Manager",
>	"permissions": [
>	"bulk_edit",
>	"export"
>	],
>	"visibility_user_lcf_behavior": null,
>	"visibility_user_lcf_ids": null
>	}'

1	{
2	"editable": true,
3	"id": "role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p",
4	"name": "Account Manager",
5	"permissions": [
6	"bulk_edit",
7	"export"
8	],
9	"visibility_user_lcf_behavior": null,
10	"visibility_user_lcf_ids": null
11	}