Associate a Shared Custom Field with an object type
Associates a Shared Custom Field with an object type such as Lead, Contact, or Custom Activity Type. Once associated, the Shared Custom Field can be set on objects of that type.
This endpoint accepts the following attributes:
- `object_type` – can be one of: `lead`, `contact`, `opportunity`, `custom_activity_type`,
`custom_object_type`.
- `custom_activity_type_id` – ID of the Custom Activity Type that you want to
associate this Shared Field with. Only relevant if you chose the `object_type` of `custom_activity_type`.
- `custom_object_type_id` – ID of the Custom Object Type that you want to
associate this Shared Field with. Only relevant if you chose the `object_type` of `custom_object_type`.
- `editable_with_roles` – list of [Roles](https://developer.close.com/api/resources/roles) that can edit the values of
this Field on the given object. Note that this is a per-association setting, meaning that editing of the Shared Custom Field can be restricted on one object and not restricted on another.
- `required` – whether a value *must* be provided for this Field on the given
object. Only relevant if you chose the `object_type` of `custom_activity_type` or `custom_object_type`. Note that this is a per-association setting, meaning that this Shared Custom Field can be required on one object and not required on another.
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.
Path parameters
scf_id
Request
This endpoint expects any.
Response
Successful response
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error