---
isPublished: true
knowledgeIndex: false
hidden: true
noindex: true
template: "page.peb"
title: "Add Room Member Flow Action"
description: "Add a Contact or User as a member of an existing Room."
contentType: "reference"
audience: "admin,developer"
---

# Add Room Member

Add a Contact or User as a member of an existing Room.
The namespaced Apex action name is `rooms__InviteRoomMemberAction`.
Check action availability and input fields in your installed package.

## Transaction summary

| Effect | Behavior |
| --- | --- |
| API callout | No immediate API callout in member preparation. Synchronization and token work can call out later. |
| Record writes | Upserts Room Member records. Updates the Room and related Contact or Lead membership references. Checklist and Item records can also change. Error or diagnostic Events can be created. |
| Queued work | Yes, when synchronization is enabled. Activity, link and Room work can continue after this action returns. |
| Email | Conditional. Invitation processing can send native Salesforce email or queue invitation delivery. |

Select Contact ID or User ID and the intended Room.
Lead ID alone is not accepted and is not used as the recipient selector by this action.
Send Email Invitation defaults to true. Set it false if a later step must control delivery.
Sync Room with API set to false defers synchronization and invitation delivery.
The action can publish member-added and member-invited platform events.

## Inputs

**Required** describes the Flow input setting. The processing rules above also apply.

| API name | Flow label | Required | Default or guidance |
| --- | --- | --- | --- |
| `roomId` | Room ID | Yes | Select the existing Room. It is required for processing. |
| `masterRecordId` | Record ID | No | Related business record. This does not replace Room ID. |
| `contactId` | Contact ID | No | Select a Contact, or use User ID for a User recipient. |
| `leadId` | Lead ID | No | Retained compatibility input. Lead ID alone is not accepted or forwarded as the recipient selector. |
| `userId` | User ID | No | Select a Salesforce User when the recipient is a User. |
| `role` | Role: Administrator, Collaborator, Viewer, or None | No | Default: `Collaborator`. Administrator and Viewer select their matching access. Do not use None to disable access; that value does not select a no-access role here. |
| `sendInvite` | Send Email Invitation | No | Default: `true`. Requests an invitation when synchronization and delivery are enabled. |
| `replyTo` | Reply To | No | Optional reply-to email address. |
| `senderDisplayName` | Sender Display Name | No | Optional email sender display name. |
| `useEmailSignature` | Use Native Email Signature | No | Default: `false`. Controls the native email signature option. |
| `emailTemplate` | Email Template Name (Optional. Portal notification used by default) | No | Optional email template name. Otherwise the configured Room invitation content is used. |
| `signerOrder` | Signer Order (default 0 ) | No | Default: `0`. Sets the member signer order. It does not prove that the document is signable. |
| `syncRoomAPI` | Sync Room with API (Default=true) | No | Default: `true`. Enables Room synchronization and invitation processing. When false, synchronize separately after record preparation. |

## Outputs

| API name | Flow label | Meaning |
| --- | --- | --- |
| `success` | Success | Whether member preparation reported success. Check the intended member and delivery separately. |
| `message` | Message | Result or error details. |
| `memberID` | Member ID | The Room Member reference when supplied. Verify its Room and recipient. |

## Configure the Flow

1. Select the existing Room and recipient identity.
2. Set the member role, explicit signer order and invitation options.
3. Store Success, Message and Member ID.
4. Check that the returned member belongs to the intended Room and recipient. Verify delivery separately.

Review the Flow context, Apex action access and the object and field permissions needed by this operation.
Record writes can run other Salesforce automation.
For API work, also review the configured Salesforce API connection user's required access.

## Troubleshooting

**Member creation fails.** Check Room ID, recipient ID, member creation access and Message.

**Email was not sent.** Check Send Email Invitation, Sync Room with API, the recipient email and the configured template. A created member is not proof of email delivery.

**A later callout reports uncommitted work.** This action writes records, publishes events and can queue work. Review the next action transaction boundary.

See the [Flow action index](/content/build/flows/index.md) for transaction guidance and related actions.
