diff --git a/docs/organizations/invitations.mdx b/docs/organizations/invitations.mdx index ee36ab07bf..475b0a48ff 100644 --- a/docs/organizations/invitations.mdx +++ b/docs/organizations/invitations.mdx @@ -72,7 +72,7 @@ Once the user visits the invitation link, they will be redirected to the page yo ### Invitation metadata -You can also add metadata to an invitation when creating the invitation through the Backend API. Once the invited user signs up using the invitation link, the invitation metadata (`OrganizationInvitation.public_metadata`) will be stored in the user's metadata (`User.public_metadata`). You can find more information about user metadata in the [metadata](/docs/users/metadata) docs. +You can also add metadata to an invitation when creating the invitation through the Backend API. Once the invited user signs up using the invitation link, the invitation metadata (`OrganizationInvitation.public_metadata`) will be stored in the organization membership's metadata (`OrganizationMembership.publicMetadata`). You can find more information about organization membership metadata in the [Organization Membership](/docs/references/javascript/organization-membership) docs. To add metadata to an invitation, you can use the `public_metadata` property when the invitation is created. @@ -91,7 +91,7 @@ curl 'https://api.clerk.com/v1/organizations//invitations' -X POST \ -H 'Authorization: Bearer {{secret}}' \ -H 'Content-Type: application/json' \ - -d '{ "inviter_user_id": "user_123", "email_address": "test@gmail.com", "role": "org:member", "public_metadata": {"age": "21"} }' + -d '{ "inviter_user_id": "user_123", "email_address": "test@gmail.com", "role": "org:member", "public_metadata": {"department": "marketing"} }' ``` ## Revoke an invitation