Skip to navigation

Create a new role

View as Markdown

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.
OR
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