> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # CreateBadgeAssignment # Package: activity # Namespace: BadgeAssignments # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/activity/badge-assignments/create-badge-assignment.md ## Permission Scopes: Manage Badges: SCOPE.DC-MEMBERS.MANAGE-BADGES ## Introduction Assigns a badge to a member. To assign multiple badges to multiple members, call [Bulk Create Badge Assignments](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badge-assignments/bulk-create-badge-assignments.md). --- ## REST API ### Schema ``` Method: createBadgeAssignment Description: Assigns a badge to a member. To assign multiple badges to multiple members, call [Bulk Create Badge Assignments](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badge-assignments/bulk-create-badge-assignments.md). URL: https://www.wixapis.com/v4/badge-assignments Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: badgeAssignment, badgeAssignment.badgeId, badgeAssignment.memberId Method parameters: param name: badgeAssignment | type: BadgeAssignment | description: A badge assignment represents the relationship between a badge and a member. When a badge assignment is created, the specified member receives the badge and any associated permissions or privileges. | required: true - name: badgeId | type: string | description: GUID of the badge being assigned to the member. Call the [Badges API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badges-v4/introduction.md) to retrieve available badges. | required: true - name: memberId | type: string | description: GUID of the member receiving the badge assignment. Call the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction.md) to retrieve member information. | required: true - name: tags | type: Tags | description: Tags allow you to classify ticket reservations. Learn more about [tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md). - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: extendedFields | type: ExtendedFields | description: Extended fields allow you to add custom properties beyond the standard reservation data. Learn more about [extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md). - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Return type: CreateBadgeAssignmentResponse - name: badgeAssignment | type: BadgeAssignment | description: Created badge assignment. - name: id | type: string | description: Badge assignment GUID. - name: badgeId | type: string | description: GUID of the badge being assigned to the member. Call the [Badges API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badges-v4/introduction.md) to retrieve available badges. - name: memberId | type: string | description: GUID of the member receiving the badge assignment. Call the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction.md) to retrieve member information. - name: createdDate | type: string | description: Date and time the badge assignment was created. - name: updatedDate | type: string | description: Date and time the badge assignment was updated. - name: tags | type: Tags | description: Tags allow you to classify ticket reservations. Learn more about [tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md). - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: extendedFields | type: ExtendedFields | description: Extended fields allow you to add custom properties beyond the standard reservation data. Learn more about [extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md). - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). ``` ### Examples ### Create Badge Assignment ```curl curl -X POST \ https://www.wixapis.com/badges/v4/assignments \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "badgeAssignment": { "badgeId": "d3405ceb-5640-46e3-8163-5f110bf1db3a", "memberId": "e7c0a2f8-4b9d-4b8a-9f3c-1e2d3f4a5b6c" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.activity.BadgeAssignments.createBadgeAssignment(badgeAssignment) Description: Assigns a badge to a member. To assign multiple badges to multiple members, call [Bulk Create Badge Assignments](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badge-assignments/bulk-create-badge-assignments.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: badgeAssignment, badgeAssignment.badgeId, badgeAssignment.memberId Method parameters: param name: badgeAssignment | type: BadgeAssignment | description: A badge assignment represents the relationship between a badge and a member. When a badge assignment is created, the specified member receives the badge and any associated permissions or privileges. | required: true - name: badgeId | type: string | description: GUID of the badge being assigned to the member. Call the [Badges API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badges-v4/introduction.md) to retrieve available badges. | required: true - name: memberId | type: string | description: GUID of the member receiving the badge assignment. Call the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction.md) to retrieve member information. | required: true - name: tags | type: Tags | description: Tags allow you to classify ticket reservations. Learn more about [tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md). - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: extendedFields | type: ExtendedFields | description: Extended fields allow you to add custom properties beyond the standard reservation data. Learn more about [extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md). - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Return type: PROMISE - name: _id | type: string | description: Badge assignment GUID. - name: badgeId | type: string | description: GUID of the badge being assigned to the member. Call the [Badges API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/badges-v4/introduction.md) to retrieve available badges. - name: memberId | type: string | description: GUID of the member receiving the badge assignment. Call the [Members API](https://dev.wix.com/docs/api-reference/crm/members-contacts/members/members/introduction.md) to retrieve member information. - name: _createdDate | type: Date | description: Date and time the badge assignment was created. - name: _updatedDate | type: Date | description: Date and time the badge assignment was updated. - name: tags | type: Tags | description: Tags allow you to classify ticket reservations. Learn more about [tags](https://dev.wix.com/docs/rest/business-management/tags/introduction.md). - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. - name: extendedFields | type: ExtendedFields | description: Extended fields allow you to add custom properties beyond the standard reservation data. Learn more about [extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md). - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). ``` ### Examples ### createBadgeAssignment ```javascript import { badgeAssignments } from '@wix/members'; async function createBadgeAssignment(badgeAssignment) { const response = await badgeAssignments.createBadgeAssignment(badgeAssignment); }; ``` ### createBadgeAssignment (with elevated permissions) ```javascript import { badgeAssignments } from '@wix/members'; import { auth } from '@wix/essentials'; async function myCreateBadgeAssignmentMethod(badgeAssignment) { const elevatedCreateBadgeAssignment = auth.elevate(badgeAssignments.createBadgeAssignment); const response = await elevatedCreateBadgeAssignment(badgeAssignment); } ``` ### createBadgeAssignment (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { badgeAssignments } from '@wix/members'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { badgeAssignments }, // Include the auth strategy and host as relevant }); async function createBadgeAssignment(badgeAssignment) { const response = await myWixClient.badgeAssignments.createBadgeAssignment(badgeAssignment); }; ``` ---