Create a non-member contact (lead). To add a full community member instead, use create_community_member.
create_leadCreate a non-member contact (lead) in a Circle community by providing an email and optional name or member tags. Set confirm=true to apply this state-changing action when the user explicitly requests it.
Instructions
Create a non-member contact (lead). To add a full community member instead, use create_community_member.. Changes community state and requires confirm=true for the user-requested action.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Display name of the contact. | |
| No | Email address of the contact. Must not already belong to a member or an existing non-member contact in this community. | ||
| account | No | Named private Circle account; selects credentials, not a remote community ID. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete JSON request body instead of body flags. Supports nested Tiptap, maps and nullable values. | |
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. | |
| member_tag_ids | No | IDs of existing member tags to apply to the new contact. Use the member_tags endpoints to look these up. |