{"id":"c4a658f2-30b8-43f3-bfef-211eb9c8addd","createdDate":"2023-07-30T12:43:13.097Z","updatedDate":"2023-07-30T12:43:13.097Z","resourceId":"44861079-fbda-471f-9453-a90bf89b1513","api":{"schema":{"object":{"displayName":"Badge Object","description":"","slug":"badge-object","$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"List Badges","description":"Retrieves up to 1000 badges, given the requested paging.\nDefault `paging.limit` is 100, `paging.offset` - 0.\nFor more information, see\n[API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).","operationId":"com.wixpress.badges.v3.BadgesServiceV3.ListBadges","parameters":[{"name":"paging","in":"query","description":"Pagination options. For more information, see\n[API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).","required":false,"schema":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Pagination options. For more information, see\n[API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.ListBadgesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.ListBadgesRequest","responseMessage":"com.wixpress.badges.v3.ListBadgesResponse"},"legacyExamples":[{"name":"ListBadges","type":"METHOD","content":{"title":"List badges","description":"Retrieving badges","request":"curl -X GET \\\n 'https://www.wixapis.com/members/v3/badges?paging.limit=4&paging.offset=1' \\\n -H 'Authorization: '","response":"{\n \"badges\": [\n {\n \"id\": \"ce700e2e-ded6-4e30-9638-6be7a9eec91b\",\n \"title\": \"VIP\",\n \"description\": \"\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"vip\",\n \"createdDate\": \"2020-05-27T12:19:06.978Z\",\n \"updatedDate\": \"2020-05-27T12:19:06.978Z\"\n },\n {\n \"id\": \"99b12184-d3c3-441a-8659-789e0007b634\",\n \"title\": \"Moderator\",\n \"description\": \"Moderator\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"moderator\",\n \"createdDate\": \"2020-05-27T12:18:08.329Z\",\n \"updatedDate\": \"2020-05-27T12:18:08.329Z\"\n },\n {\n \"id\": \"ffdc5c7d-d080-4c7c-869e-a8c4478532c0\",\n \"title\": \"MVP\",\n \"description\": \"Most valuable player\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"mvp\",\n \"createdDate\": \"2020-05-27T12:17:54.024Z\",\n \"updatedDate\": \"2020-05-27T12:17:54.024Z\"\n },\n {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T09:26:17.699Z\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 1,\n \"total\": 10,\n \"tooManyToCount\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v3/badges","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.ListBadgesRequest","responseMessage":"com.wixpress.badges.v3.ListBadgesResponse"},"legacyExamples":[{"name":"ListBadges","type":"METHOD","content":{"title":"List badges","description":"Retrieving badges","request":"curl -X GET \\\n 'https://www.wixapis.com/members/v3/badges?paging.limit=4&paging.offset=1' \\\n -H 'Authorization: '","response":"{\n \"badges\": [\n {\n \"id\": \"ce700e2e-ded6-4e30-9638-6be7a9eec91b\",\n \"title\": \"VIP\",\n \"description\": \"\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"vip\",\n \"createdDate\": \"2020-05-27T12:19:06.978Z\",\n \"updatedDate\": \"2020-05-27T12:19:06.978Z\"\n },\n {\n \"id\": \"99b12184-d3c3-441a-8659-789e0007b634\",\n \"title\": \"Moderator\",\n \"description\": \"Moderator\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"moderator\",\n \"createdDate\": \"2020-05-27T12:18:08.329Z\",\n \"updatedDate\": \"2020-05-27T12:18:08.329Z\"\n },\n {\n \"id\": \"ffdc5c7d-d080-4c7c-869e-a8c4478532c0\",\n \"title\": \"MVP\",\n \"description\": \"Most valuable player\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"mvp\",\n \"createdDate\": \"2020-05-27T12:17:54.024Z\",\n \"updatedDate\": \"2020-05-27T12:17:54.024Z\"\n },\n {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T09:26:17.699Z\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 1,\n \"total\": 10,\n \"tooManyToCount\": false\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Badges","slugifiedName":"list-badges"}},{"summary":"Create Badge","description":"Creates a new badge.","operationId":"com.wixpress.badges.v3.BadgesServiceV3.CreateBadge","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.CreateBadgeResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateBadgeRequest","description":"","properties":{"badge":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","summary":"badge","description":"Badge to create.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["badge","badge.title","badge.backgroundColor","badge.textColor"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Badge Created","description":"Triggered when a badge is created.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_CREATE"],"externalPermissionScopes":[{"name":"Manage Badges","scopeId":"SCOPE.DC-MEMBERS.MANAGE-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.CreateBadgeRequest","responseMessage":"com.wixpress.badges.v3.CreateBadgeResponse"},"legacyExamples":[{"name":"CreateBadge","type":"METHOD","order":1,"content":{"title":"Create a badge with enabled permissions","request":"curl -X POST \\\n 'https://www.wixapis.com/members/v3/badges/members' \\\n -H 'Authorization: '\n -d '{\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": true\n }'","response":"{\n \"badge\": {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": true,\n \"slug\": \"awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T09:26:17.699Z\"\n }\n}"}},{"name":"CreateBadge","type":"METHOD","content":{"title":"Create a badge","request":"curl -X POST \\\n 'https://www.wixapis.com/members/v3/badges/members' \\\n -H 'Authorization: '\n -d '{\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\"\n }'","response":"{\n \"badge\": {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T09:26:17.699Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v3/badges","rpcOnly":false,"triggeredEvents":[{"title":"Badge Created","description":"Triggered when a badge is created.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_CREATE"],"externalPermissionScopes":[{"name":"Manage Badges","scopeId":"SCOPE.DC-MEMBERS.MANAGE-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.CreateBadgeRequest","responseMessage":"com.wixpress.badges.v3.CreateBadgeResponse"},"legacyExamples":[{"name":"CreateBadge","type":"METHOD","order":1,"content":{"title":"Create a badge with enabled permissions","request":"curl -X POST \\\n 'https://www.wixapis.com/members/v3/badges/members' \\\n -H 'Authorization: '\n -d '{\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": true\n }'","response":"{\n \"badge\": {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": true,\n \"slug\": \"awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T09:26:17.699Z\"\n }\n}"}},{"name":"CreateBadge","type":"METHOD","content":{"title":"Create a badge","request":"curl -X POST \\\n 'https://www.wixapis.com/members/v3/badges/members' \\\n -H 'Authorization: '\n -d '{\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\"\n }'","response":"{\n \"badge\": {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T09:26:17.699Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Create Badge","slugifiedName":"create-badge"}},{"summary":"Update Badge","description":"Updates a badge's specified properties.","operationId":"com.wixpress.badges.v3.BadgesServiceV3.UpdateBadge","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"badge.id","description":"Badge ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.UpdateBadgeResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateBadgeRequest","description":"","properties":{"badge":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","summary":"badge","description":"Badge to update.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["badge","badge.id"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Badge Updated","description":"Triggered when a badge is updated.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_UPDATE"],"externalPermissionScopes":[{"name":"Manage Badges","scopeId":"SCOPE.DC-MEMBERS.MANAGE-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.UpdateBadgeRequest","responseMessage":"com.wixpress.badges.v3.UpdateBadgeResponse"},"legacyExamples":[{"name":"UpdateBadge","type":"METHOD","content":{"title":"Update a badge","request":"curl -X PATCH \\\n 'https://www.wixapis.com/members/v3/badges/members/80d5e4aa-0ab2-4bab-b941-a7459239a02e' \\\n -H 'Authorization: '\n -d '{\n \"title\": \"The Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\"\n }'","response":"{\n \"badge\": {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"The Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"the-awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T10:21:18.975Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v3/badges/{badge.id}","rpcOnly":false,"triggeredEvents":[{"title":"Badge Updated","description":"Triggered when a badge is updated.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_UPDATE"],"externalPermissionScopes":[{"name":"Manage Badges","scopeId":"SCOPE.DC-MEMBERS.MANAGE-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.UpdateBadgeRequest","responseMessage":"com.wixpress.badges.v3.UpdateBadgeResponse"},"legacyExamples":[{"name":"UpdateBadge","type":"METHOD","content":{"title":"Update a badge","request":"curl -X PATCH \\\n 'https://www.wixapis.com/members/v3/badges/members/80d5e4aa-0ab2-4bab-b941-a7459239a02e' \\\n -H 'Authorization: '\n -d '{\n \"title\": \"The Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\"\n }'","response":"{\n \"badge\": {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"The Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"the-awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T10:21:18.975Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Badge","slugifiedName":"update-badge"}},{"summary":"Query Badges","description":"Retrieves up to 1000 badges, given the requested query options, paging, and sorting.\nDefault `paging.limit` is 100, `paging.offset` - 0.\nFor more information, see\n[API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).","operationId":"com.wixpress.badges.v3.BadgesServiceV3.QueryBadges","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.QueryBadgesResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryBadgesRequest","description":"","properties":{"filter":{"title":"filter","description":"Filter options.\nCurrently supported fields for filtering:\n- id\n- title\n- slug\nFor more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"title":"sort","description":"Sorting options.\nFor more details on how to use sorting,\nsee [API Query Language: The Sort Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-sort-section)","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Pagination options. For more information, see\n[API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.QueryBadgesRequest","responseMessage":"com.wixpress.badges.v3.QueryBadgesResponse"},"legacyExamples":[{"name":"QueryBadges","type":"METHOD","content":{"title":"Query badges","description":"Retrieving badges with filter and sorting","request":"curl -X POST 'https://www.wixapis.com/members/v3/badges/query' \\\n -H 'Authorization: '\n -d '{\n \"filter\": {\n \t\"$or\": [\n \t {\"title\": \"VIP\"},\n \t {\"title\": \"MVP\"}\n ]\n },\n \"sorting\": [\n {\"fieldName\":\"title\", \"direction\": \"DESC\"}\n ]\n }'","response":"{\n \"badges\": [\n {\n \"id\": \"ffdc5c7d-d080-4c7c-869e-a8c4478532c0\",\n \"title\": \"MVP\",\n \"description\": \"Most valuable player\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"mvp\",\n \"createdDate\": \"2020-05-27T12:17:54.024Z\",\n \"updatedDate\": \"2020-05-27T12:17:54.024Z\"\n },\n {\n \"id\": \"ce700e2e-ded6-4e30-9638-6be7a9eec91b\",\n \"title\": \"VIP\",\n \"description\": \"\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"vip\",\n \"createdDate\": \"2020-05-27T12:19:06.978Z\",\n \"updatedDate\": \"2020-05-27T12:19:06.978Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2,\n \"tooManyToCount\": false\n }\n}"}},{"name":"QueryBadges","type":"METHOD","order":1,"content":{"title":"Query for all badges","description":"Retrieving all badges by passing an empty filter","request":"curl -X POST 'https://www.wixapis.com/members/v3/badges/query' \\\n -H 'Authorization: '\n -d '{\n \"filter\": {},\n \"sorting\": [],\n \"paging\": {}\n}'","response":"{\n \"badges\": [\n {\n \"id\": \"91e9c1ac-aea4-4329-84ef-093c55595cde\",\n \"title\": \"Top Contributor\",\n \"description\": \"Contributed most posts this month\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"top-contributor\",\n \"createdDate\": \"2021-10-18T12:07:43.560Z\",\n \"updatedDate\": \"2021-10-18T12:07:43.560Z\"\n },\n {\n \"id\": \"0f223639-56a5-4e09-b785-d80392c413ed\",\n \"title\": \"Conversation Starter\",\n \"description\": \"Added the first comment on a post.\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"conversation-starter\",\n \"createdDate\": \"2021-10-18T12:08:13.191Z\",\n \"updatedDate\": \"2021-10-18T12:08:13.191Z\"\n },\n {\n \"id\": \"fdcbd071-f943-4bb2-bf6d-001bbb9dc495\",\n \"title\": \"Community Builder\",\n \"description\": \"Special access and moderation permissions.\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"community-builder\",\n \"createdDate\": \"2021-10-18T12:08:44.930Z\",\n \"updatedDate\": \"2021-10-18T12:08:44.930Z\"\n }\n ],\n \"metadata\": {\n \"count\": 3,\n \"total\": 3\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v3/badges/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.QueryBadgesRequest","responseMessage":"com.wixpress.badges.v3.QueryBadgesResponse"},"legacyExamples":[{"name":"QueryBadges","type":"METHOD","content":{"title":"Query badges","description":"Retrieving badges with filter and sorting","request":"curl -X POST 'https://www.wixapis.com/members/v3/badges/query' \\\n -H 'Authorization: '\n -d '{\n \"filter\": {\n \t\"$or\": [\n \t {\"title\": \"VIP\"},\n \t {\"title\": \"MVP\"}\n ]\n },\n \"sorting\": [\n {\"fieldName\":\"title\", \"direction\": \"DESC\"}\n ]\n }'","response":"{\n \"badges\": [\n {\n \"id\": \"ffdc5c7d-d080-4c7c-869e-a8c4478532c0\",\n \"title\": \"MVP\",\n \"description\": \"Most valuable player\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"mvp\",\n \"createdDate\": \"2020-05-27T12:17:54.024Z\",\n \"updatedDate\": \"2020-05-27T12:17:54.024Z\"\n },\n {\n \"id\": \"ce700e2e-ded6-4e30-9638-6be7a9eec91b\",\n \"title\": \"VIP\",\n \"description\": \"\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"vip\",\n \"createdDate\": \"2020-05-27T12:19:06.978Z\",\n \"updatedDate\": \"2020-05-27T12:19:06.978Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2,\n \"tooManyToCount\": false\n }\n}"}},{"name":"QueryBadges","type":"METHOD","order":1,"content":{"title":"Query for all badges","description":"Retrieving all badges by passing an empty filter","request":"curl -X POST 'https://www.wixapis.com/members/v3/badges/query' \\\n -H 'Authorization: '\n -d '{\n \"filter\": {},\n \"sorting\": [],\n \"paging\": {}\n}'","response":"{\n \"badges\": [\n {\n \"id\": \"91e9c1ac-aea4-4329-84ef-093c55595cde\",\n \"title\": \"Top Contributor\",\n \"description\": \"Contributed most posts this month\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"top-contributor\",\n \"createdDate\": \"2021-10-18T12:07:43.560Z\",\n \"updatedDate\": \"2021-10-18T12:07:43.560Z\"\n },\n {\n \"id\": \"0f223639-56a5-4e09-b785-d80392c413ed\",\n \"title\": \"Conversation Starter\",\n \"description\": \"Added the first comment on a post.\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"conversation-starter\",\n \"createdDate\": \"2021-10-18T12:08:13.191Z\",\n \"updatedDate\": \"2021-10-18T12:08:13.191Z\"\n },\n {\n \"id\": \"fdcbd071-f943-4bb2-bf6d-001bbb9dc495\",\n \"title\": \"Community Builder\",\n \"description\": \"Special access and moderation permissions.\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"\",\n \"permissionsEnabled\": false,\n \"slug\": \"community-builder\",\n \"createdDate\": \"2021-10-18T12:08:44.930Z\",\n \"updatedDate\": \"2021-10-18T12:08:44.930Z\"\n }\n ],\n \"metadata\": {\n \"count\": 3,\n \"total\": 3\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Query Badges","slugifiedName":"query-badges"}},{"summary":"Get Badge","description":"Retrieves a badge.","operationId":"com.wixpress.badges.v3.BadgesServiceV3.GetBadge","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Badge ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.GetBadgeResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.GetBadgeRequest","responseMessage":"com.wixpress.badges.v3.GetBadgeResponse"},"legacyExamples":[{"name":"GetBadge","type":"METHOD","content":{"title":"Get a badge","description":"Retrieving a badge by ID","request":"curl -X GET \\\n 'https://www.wixapis.com/members/v3/badges/80d5e4aa-0ab2-4bab-b941-a7459239a02e' \\\n -H 'Authorization: '","response":"{\n \"badge\": {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T09:26:17.699Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v3/badges/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.GetBadgeRequest","responseMessage":"com.wixpress.badges.v3.GetBadgeResponse"},"legacyExamples":[{"name":"GetBadge","type":"METHOD","content":{"title":"Get a badge","description":"Retrieving a badge by ID","request":"curl -X GET \\\n 'https://www.wixapis.com/members/v3/badges/80d5e4aa-0ab2-4bab-b941-a7459239a02e' \\\n -H 'Authorization: '","response":"{\n \"badge\": {\n \"id\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"title\": \"Awesome Badge\",\n \"description\": \"Badge for awesome people\",\n \"backgroundColor\": \"#FFFFFF\",\n \"textColor\": \"#FF0000\",\n \"icon\": \"https://my-icons.example/awesome.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"awesome-badge\",\n \"createdDate\": \"2020-05-28T09:26:17.699Z\",\n \"updatedDate\": \"2020-05-28T09:26:17.699Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Badge","slugifiedName":"get-badge"}},{"summary":"Delete Badge","description":"Deletes a badge.","operationId":"com.wixpress.badges.v3.BadgesServiceV3.DeleteBadge","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Badge ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.DeleteBadgeResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Badge Deleted","description":"Triggered when a badge is deleted.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"DELETED","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_DELETE"],"externalPermissionScopes":[{"name":"Manage Badges","scopeId":"SCOPE.DC-MEMBERS.MANAGE-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.DeleteBadgeRequest","responseMessage":"com.wixpress.badges.v3.DeleteBadgeResponse"},"legacyExamples":[{"name":"DeleteBadge","type":"METHOD","content":{"title":"Delete a badge","request":"curl -X DELETE \\\n 'https://www.wixapis.com/members/v3/badges/80d5e4aa-0ab2-4bab-b941-a7459239a02e' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"delete","path":"/v3/badges/{id}","rpcOnly":false,"triggeredEvents":[{"title":"Badge Deleted","description":"Triggered when a badge is deleted.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"DELETED","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_DELETE"],"externalPermissionScopes":[{"name":"Manage Badges","scopeId":"SCOPE.DC-MEMBERS.MANAGE-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.DeleteBadgeRequest","responseMessage":"com.wixpress.badges.v3.DeleteBadgeResponse"},"legacyExamples":[{"name":"DeleteBadge","type":"METHOD","content":{"title":"Delete a badge","request":"curl -X DELETE \\\n 'https://www.wixapis.com/members/v3/badges/80d5e4aa-0ab2-4bab-b941-a7459239a02e' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Delete Badge","slugifiedName":"delete-badge"}},{"summary":"List Badges Per Member","description":"Retrieves badges assigned to the requested members.","operationId":"com.wixpress.badges.v3.BadgesServiceV3.ListMembersBadgeIds","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.ListMembersBadgeIdsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ListMembersBadgeIdsRequest","description":"","properties":{"memberIds":{"title":"memberIds","description":"List of members.","format":"GUID","minItems":1,"maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["memberIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ_MEMBERS"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.ListMembersBadgeIdsRequest","responseMessage":"com.wixpress.badges.v3.ListMembersBadgeIdsResponse"},"legacyExamples":[{"name":"ListMembersBadgeIds","type":"METHOD","content":{"title":"List members badge ids","description":"Retrieving badge ids assigned to members","request":"curl -X POST \\\n 'https://www.wixapis.com/members/v3/badges/members' \\\n -H 'Authorization: '\n -d '{\n \"memberIds\": [\n \"cdd1993d-811e-453d-8a0e-b9e0f7780b96\",\n \"b32b708e-d531-42fb-846b-f23c367d9c92\"\n ]\n }'","response":"{\n \"memberBadgeIds\": [\n {\n \"memberId\": \"cdd1993d-811e-453d-8a0e-b9e0f7780b96\",\n \"badgeIds\": [\n \"ce700e2e-ded6-4e30-9638-6be7a9eec91b\",\n \"ffdc5c7d-d080-4c7c-869e-a8c4478532c0\"\n ]\n },\n {\n \"memberId\": \"b32b708e-d531-42fb-846b-f23c367d9c92\",\n \"badgeIds\": [\n \"ce700e2e-ded6-4e30-9638-6be7a9eec91b\"\n ]\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v3/badges/members","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ_MEMBERS"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.ListMembersBadgeIdsRequest","responseMessage":"com.wixpress.badges.v3.ListMembersBadgeIdsResponse"},"legacyExamples":[{"name":"ListMembersBadgeIds","type":"METHOD","content":{"title":"List members badge ids","description":"Retrieving badge ids assigned to members","request":"curl -X POST \\\n 'https://www.wixapis.com/members/v3/badges/members' \\\n -H 'Authorization: '\n -d '{\n \"memberIds\": [\n \"cdd1993d-811e-453d-8a0e-b9e0f7780b96\",\n \"b32b708e-d531-42fb-846b-f23c367d9c92\"\n ]\n }'","response":"{\n \"memberBadgeIds\": [\n {\n \"memberId\": \"cdd1993d-811e-453d-8a0e-b9e0f7780b96\",\n \"badgeIds\": [\n \"ce700e2e-ded6-4e30-9638-6be7a9eec91b\",\n \"ffdc5c7d-d080-4c7c-869e-a8c4478532c0\"\n ]\n },\n {\n \"memberId\": \"b32b708e-d531-42fb-846b-f23c367d9c92\",\n \"badgeIds\": [\n \"ce700e2e-ded6-4e30-9638-6be7a9eec91b\"\n ]\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"List Badges Per Member","slugifiedName":"list-badges-per-member"}},{"summary":"Get Member Counts Per Badge","description":"Retrieves member count per badge.","operationId":"com.wixpress.badges.v3.BadgesServiceV3.GetMemberCountsPerBadge","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.GetMemberCountsPerBadgeResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ_MEMBERS"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.GetMemberCountsPerBadgeRequest","responseMessage":"com.wixpress.badges.v3.GetMemberCountsPerBadgeResponse"},"legacyExamples":[{"name":"GetMemberCountsPerBadge","type":"METHOD","content":{"title":"Get member counts per badge","request":"curl -X GET \\\n 'https://www.wixapis.com/members/v3/badges/members/count' \\\n -H 'Authorization: '","response":"{\n \"badgeMemberCounts\": [\n {\n \"badgeId\": \"930c2ef8-ef04-4397-8825-a4b231b43d0a\",\n \"memberCount\": 1\n },\n {\n \"badgeId\": \"99b12184-d3c3-441a-8659-789e0007b634\",\n \"memberCount\": 1\n },\n {\n \"badgeId\": \"ffdc5c7d-d080-4c7c-869e-a8c4478532c0\",\n \"memberCount\": 2\n },\n {\n \"badgeId\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"memberCount\": 1\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v3/badges/members/count","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_READ_MEMBERS"],"externalPermissionScopes":[{"name":"Read Badges","scopeId":"SCOPE.DC-MEMBERS.READ-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.GetMemberCountsPerBadgeRequest","responseMessage":"com.wixpress.badges.v3.GetMemberCountsPerBadgeResponse"},"legacyExamples":[{"name":"GetMemberCountsPerBadge","type":"METHOD","content":{"title":"Get member counts per badge","request":"curl -X GET \\\n 'https://www.wixapis.com/members/v3/badges/members/count' \\\n -H 'Authorization: '","response":"{\n \"badgeMemberCounts\": [\n {\n \"badgeId\": \"930c2ef8-ef04-4397-8825-a4b231b43d0a\",\n \"memberCount\": 1\n },\n {\n \"badgeId\": \"99b12184-d3c3-441a-8659-789e0007b634\",\n \"memberCount\": 1\n },\n {\n \"badgeId\": \"ffdc5c7d-d080-4c7c-869e-a8c4478532c0\",\n \"memberCount\": 2\n },\n {\n \"badgeId\": \"80d5e4aa-0ab2-4bab-b941-a7459239a02e\",\n \"memberCount\": 1\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Member Counts Per Badge","slugifiedName":"get-member-counts-per-badge"}},{"summary":"Update Badges Display Order","description":"Updates badges' display order.","operationId":"com.wixpress.badges.v3.BadgesServiceV3.UpdateBadgesDisplayOrder","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.badges.v3.UpdateBadgesDisplayOrderResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/members/v3/badges","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/members/v3/badges","destinationPath":"/v3/badges","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateBadgesDisplayOrderRequest","description":"","properties":{"badgeIds":{"title":"badgeIds","description":"Ordered badge IDs.","format":"GUID","minItems":1,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["badgeIds"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_UPDATE_DISPLAY_ORDER"],"externalPermissionScopes":[{"name":"Manage Badges","scopeId":"SCOPE.DC-MEMBERS.MANAGE-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.UpdateBadgesDisplayOrderRequest","responseMessage":"com.wixpress.badges.v3.UpdateBadgesDisplayOrderResponse"},"legacyExamples":[{"name":"UpdateBadgesDisplayOrder","type":"METHOD","content":{"title":"Update badges display order","request":"curl -X PATCH \\\n 'https://www.wixapis.com/members/v3/badges/order' \\\n -H 'Authorization: ' \\\n -d '{\n\t\"badgeIds\":\n\t\t[\n\t\t\t\"647519df-c6e8-462e-8f9d-a8f9f5939105\",\n\t\t\t\"f2cefbf1-4180-40cb-9a9c-95cdafd82ab3\"\n\t\t]\n}'","response":"{\n \"badges\": [\n {\n \"id\": \"647519df-c6e8-462e-8f9d-a8f9f5939105\",\n \"title\": \"Worker\",\n \"description\": \"\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"https://static.wixstatic.com/shapes/085c76e4c35843b3a72da08ad42cde7d.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"worker\",\n \"createdDate\": \"2021-08-05T11:34:17.987Z\",\n \"updatedDate\": \"2021-08-05T11:34:17.987Z\"\n },\n {\n \"id\": \"f2cefbf1-4180-40cb-9a9c-95cdafd82ab3\",\n \"title\": \"Player\",\n \"description\": \"\",\n \"backgroundColor\": \"#14AAF5\",\n \"textColor\": \"#FFF9D1\",\n \"icon\": \"https://static.wixstatic.com/shapes/658e7145548148ee9a621666fc8f4717.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"player\",\n \"createdDate\": \"2021-08-05T11:32:36.616Z\",\n \"updatedDate\": \"2021-08-05T11:32:36.616Z\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v3/badges/order","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.badges.v3.BadgesServiceV3","errors":[],"exposure":"PUBLIC","permissions":["BADGES.BADGE_UPDATE_DISPLAY_ORDER"],"externalPermissionScopes":[{"name":"Manage Badges","scopeId":"SCOPE.DC-MEMBERS.MANAGE-BADGES"}],"protoArtifactId":"com.wixpress.badges:members-badges-api","serviceArtifactId":"com.wixpress.badges.members-badges-server","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.badges.v3.UpdateBadgesDisplayOrderRequest","responseMessage":"com.wixpress.badges.v3.UpdateBadgesDisplayOrderResponse"},"legacyExamples":[{"name":"UpdateBadgesDisplayOrder","type":"METHOD","content":{"title":"Update badges display order","request":"curl -X PATCH \\\n 'https://www.wixapis.com/members/v3/badges/order' \\\n -H 'Authorization: ' \\\n -d '{\n\t\"badgeIds\":\n\t\t[\n\t\t\t\"647519df-c6e8-462e-8f9d-a8f9f5939105\",\n\t\t\t\"f2cefbf1-4180-40cb-9a9c-95cdafd82ab3\"\n\t\t]\n}'","response":"{\n \"badges\": [\n {\n \"id\": \"647519df-c6e8-462e-8f9d-a8f9f5939105\",\n \"title\": \"Worker\",\n \"description\": \"\",\n \"backgroundColor\": \"#796EFF\",\n \"textColor\": \"#FFFFFF\",\n \"icon\": \"https://static.wixstatic.com/shapes/085c76e4c35843b3a72da08ad42cde7d.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"worker\",\n \"createdDate\": \"2021-08-05T11:34:17.987Z\",\n \"updatedDate\": \"2021-08-05T11:34:17.987Z\"\n },\n {\n \"id\": \"f2cefbf1-4180-40cb-9a9c-95cdafd82ab3\",\n \"title\": \"Player\",\n \"description\": \"\",\n \"backgroundColor\": \"#14AAF5\",\n \"textColor\": \"#FFF9D1\",\n \"icon\": \"https://static.wixstatic.com/shapes/658e7145548148ee9a621666fc8f4717.svg\",\n \"permissionsEnabled\": false,\n \"slug\": \"player\",\n \"createdDate\": \"2021-08-05T11:32:36.616Z\",\n \"updatedDate\": \"2021-08-05T11:32:36.616Z\"\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Badges Display Order","slugifiedName":"update-badges-display-order"}}],"webhooks":[{"summary":"Badge Created","title":"Badge Created","description":"Triggered when a badge is created.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"CREATED","legacyExamples":[{"name":"BadgeCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"666fdd77-5fb8-468b-ae8d-73c56ad17093\",\n \"slug\": \"created\",\n \"id\": \"6728cb19-c2b6-4bd1-9ce8-cd44705b1498\",\n \"createdEvent\": {\n \"entity\": {\n \"backgroundColor\": \"#099A97\",\n \"icon\": \"https://static.wixstatic.com/shapes/867978b790cc4e9eb32874d02266ab81.svg\",\n \"textColor\": \"#FFFFFF\",\n \"slug\": \"beastmode\",\n \"id\": \"666fdd77-5fb8-468b-ae8d-73c56ad17093\",\n \"permissionsEnabled\": false,\n \"title\": \"Beastmode\",\n \"updatedDate\": \"2022-09-21T03:47:21.842Z\",\n \"createdDate\": \"2022-09-21T03:47:21.842Z\"\n }\n },\n \"entityFqdn\": \"wix.badges.v3.badge\",\n \"eventTime\": \"2022-09-21T03:47:21.969740Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","contentLink":{"displayName":"Badge Created","slugifiedName":"badge-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Badge Updated","title":"Badge Updated","description":"Triggered when a badge is updated.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"UPDATED","legacyExamples":[{"name":"BadgeUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"16393a50-ed14-49f0-94f0-1251a5a9a7e1\",\n \"slug\": \"updated\",\n \"id\": \"ad44d246-fb85-41ce-9f32-00ccc3e592c7\",\n \"entityFqdn\": \"wix.badges.v3.badge\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"backgroundColor\": \"#FF6EF1\",\n \"description\": \"New Badge Test\",\n \"textColor\": \"#FFFFFF\",\n \"slug\": \"professional\",\n \"id\": \"16393a50-ed14-49f0-94f0-1251a5a9a7e1\",\n \"permissionsEnabled\": false,\n \"title\": \"Professional\",\n \"updatedDate\": \"2022-09-21T03:51:38.364Z\",\n \"createdDate\": \"2022-09-19T10:10:10.209Z\"\n }\n },\n \"eventTime\": \"2022-09-21T03:51:38.454882Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","contentLink":{"displayName":"Badge Updated","slugifiedName":"badge-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Badge Deleted","title":"Badge Deleted","description":"Triggered when a badge is deleted.","permissions":["BADGES.BADGE_READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"DELETED","legacyExamples":[{"name":"BadgeDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"04a4c7d2-fb84-45c6-a488-972808dbfbd6\",\n \"slug\": \"deleted\",\n \"id\": \"4d57528a-86a4-4272-be3f-585a54691536\",\n \"entityFqdn\": \"wix.badges.v3.badge\",\n \"deletedEvent\": {},\n \"eventTime\": \"2022-09-21T03:46:16.336942Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","contentLink":{"displayName":"Badge Deleted","slugifiedName":"badge-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Badge Badge Assigned","title":"Badge Badge Assigned","description":"Triggered when a member receives a badge.","permissions":["BADGES.BADGE_READ"],"payload":{"schemaName":"com.wixpress.badges.v3.BadgeAssigned"},"exposure":"PUBLIC","maturity":"BETA","slug":"badge_assigned","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"CUSTOM_ACTION","legacyExamples":[{"name":"BadgeAssigned","eventType":"ASSIGNED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"16393a50-ed14-49f0-94f0-1251a5a9a7e1\",\n \"actionEvent\": {\n \"body\": {\n \"memberId\": \"fac761ea-e6f1-4e3d-8b30-a4852f091415\"\n }\n },\n \"slug\": \"badge_assigned\",\n \"id\": \"1bce590b-5f67-42f5-b47f-b7d6cecd077c\",\n \"entityFqdn\": \"wix.badges.v3.badge\",\n \"eventTime\": \"2022-09-21T03:33:04.836235Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.badges.v3.BadgeAssigned","contentLink":{"displayName":"Badge Assigned","slugifiedName":"badge-assigned"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Badge Badge Unassigned","title":"Badge Badge Unassigned","description":"Triggered when a member's badge is removed.","permissions":["BADGES.BADGE_READ"],"payload":{"schemaName":"com.wixpress.badges.v3.BadgeUnassigned"},"exposure":"PUBLIC","maturity":"BETA","slug":"badge_unassigned","eventTopic":"domain_events_wix.badges.v3.badge","serviceName":"com.wixpress.badges.v3.BadgesServiceV3","domainEvent":"CUSTOM_ACTION","legacyExamples":[{"name":"BadgeUnassigned","eventType":"UNASSIGNED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"16393a50-ed14-49f0-94f0-1251a5a9a7e1\",\n \"actionEvent\": {\n \"body\": {\n \"memberId\": \"f1654c62-53b4-43d5-b01b-acbf782dee6f\"\n }\n },\n \"slug\": \"badge_unassigned\",\n \"id\": \"9b5a5227-dc05-45a4-bc41-9756e1f12448\",\n \"entityFqdn\": \"wix.badges.v3.badge\",\n \"eventTime\": \"2022-09-21T03:33:14.808072Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.badges.v3.BadgeUnassigned","contentLink":{"displayName":"Badge Unassigned","slugifiedName":"badge-unassigned"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Badges\n\nThe Badges API enables site owners to create badges on their website or Wix App, and assign them to site members, either from their site dashboard, or from their live site. Badges are set up by site owners in their site dashboard. Wix does not provide preset badges.\n\nBadges assigned to specific site members help them stand out from other members. You can use badges to create specific categories of members within your site.\n\nWith the Badges API, third-party developers can customize how badges are created and assigned, including, for example, automating creation of specific categories of members who will recieve a given badge, or delegating assignment of badges to site members themselves.\n\nFor an overview of badges, see [About Member Badges](https://support.wix.com/en/article/about-member-badges).\n\n## Terminology\n\n - **Badge:** a visible label to be displayed on a site member's profile. A badge has a name (mandatory), an icon, and a background color.\n\n## Badge Permissions\nBadges can grant site members special permissions to access specific pages.\n\nSite owners can [set badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge) in the Site Members area of the dashboard.\n\nBadge permissions can't be set in the API.\n\nSite members receive permissions once a permission-granting badge is assigned to them.\n\n## Use cases\n\n**Auto assign badges for the most active members.** A third party developer wants to create a loyalty program app that auto assigns badges to members, based on their activities.\n\n * Required information\n * Retrieve member IDs from the [Site members API](https://dev.wix.com/api/rest/members/members/about-wix-members), using the [List Members endpoint](https://dev.wix.com/api/rest/members/members/list-members) to get a full list of all members.\n * Select relevant members, based on e.g. activities, orders list / bookings etc. by looking up the member IDs in the [stores API](https://dev.wix.com/api/rest/wix-stores/about-wix-stores) / [bookings APIs](https://dev.wix.com/api/rest/wix-bookings/about-wix-bookings)):\n * To select members with a long store order history, you may wish to retrieve all orders with the [Query Orders endpoint](https://dev.wix.com/api/rest/wix-stores/orders/query-orders), filtering by `buyerInfo.id`. Retrieving a list of all orders, e.g. with an empty query filter, may include buyers who are site contacts, but not site members.\n * To select members who actively book services, you may wish to use the [Query Bookings endpoint](https://dev.wix.com/api/rest/wix-bookings/bookings/bookings-reader/query-bookings) and include the `contactId` of each member retrieved from the Site Members API.\n\n * Steps\n 1. Define member group according to site owner's needs\n 2. Get currently eligible members using other APIs\n 3. Create badge using the [Create badge endpoint](https://dev.wix.com/api/rest/members/badges/create-badge)\n 4. Assign badge using the [Assign badge to members endpoint](https://dev.wix.com/api/rest/members/badges/assign-badge-to-members)\n\n**Allow site members to assign badges to other members.** A third party developer wants to create a community in which members can assign badges to one another and see available badges. For example, a site admin member may want to give certain site members access to a permissioned, \"staff only\" page on their site.\n\n * Required information\n * Member's details (Site members API)\n\n * Steps\n 1. Get all available badges on site, to display to the user for assignment, using [List badges endpoint](https://dev.wix.com/api/rest/members/badges/list-badges)\n 2. Select the permissioned, \"staff only\" badge from the list. The badge must already exist, created with permissions added by the site owner.\n 3. Assign badge to selected members, based on user input, using the [Assign badge to members endpoint](https://dev.wix.com/api/rest/members/badges/assign-badge-to-members)\n 4. Show updated listing of member's badges using the [List badges per member endpoint](https://dev.wix.com/api/rest/members/badges/list-badges-per-member)\n\n## Limitations\n\nMember permissions themselves cannot be managed via the badges API. They must be set by the site owner in the site's dashboard.\n","sourceRepo":"git@github.com:wix-private/app-market.git","path":"docs/intro.md"}],"components":{"schemas":{"com.wixpress.badges.v3.Badge":{"type":"object","properties":{"id":{"title":"id","description":"Badge ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"title":{"title":"title","description":"Text displayed on the badge in the Wix UI.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Badge description.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"backgroundColor":{"title":"backgroundColor","description":"Badge background color in hexadecimal RGB format.\nUppercase letters only.\nExample: `#FFFFFF`.","format":"COLOR_HEX","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"textColor":{"title":"textColor","description":"Badge text color in hexadecimal RGB format.\nUppercase letters only.\nExample: `#C81B53`.","format":"COLOR_HEX","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"icon":{"title":"icon","description":"URL of the badge icon image.\n_Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"permissionsEnabled":{"title":"permissionsEnabled","description":"Whether the badge has special permissions\nto access specific members-only pages.\nWhen `true`, members with the badge receive special permissions,\nand site contributors can\n[manage badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge)\nin the site dashboard.\nWhen `false`, members with the badge receive no special permissions.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"slug":{"title":"slug","description":"Slugified name. Used to represent the badge in a URL.","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Date the badge was created.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Date the badge was updated.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Badge","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wixpress.badges.v3.CreateBadgeRequest":{"type":"object","properties":{"badge":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","summary":"badge","description":"Badge to create.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateBadgeRequest","description":""},"com.wixpress.badges.v3.CreateBadgeResponse":{"type":"object","properties":{"badge":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","summary":"badge","description":"Created badge.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateBadgeResponse","description":""},"com.wixpress.badges.v3.UpdateBadgeRequest":{"type":"object","properties":{"badge":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","summary":"badge","description":"Badge to update.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateBadgeRequest","description":""},"com.wixpress.badges.v3.UpdateBadgeResponse":{"type":"object","properties":{"badge":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","summary":"badge","description":"Updated badge.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateBadgeResponse","description":""},"com.wixpress.badges.v3.ListBadgesRequest":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Pagination options. For more information, see\n[API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListBadgesRequest","description":""},"wix.common.Paging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to load.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of items to skip in the current sort order.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wixpress.badges.v3.ListBadgesResponse":{"type":"object","properties":{"badges":{"title":"badges","description":"List of badges.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge"},"x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"$ref":"#/components/schemas/wix.common.PagingMetadata","summary":"metadata","description":"Metadata for the paginated results.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListBadgesResponse","description":""},"wix.common.PagingMetadata":{"type":"object","properties":{"count":{"title":"count","description":"Number of items returned in the response.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Offset that was requested.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"title":"total","description":"Total number of items that match the query.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"tooManyToCount":{"title":"tooManyToCount","description":"Flag that indicates the server failed to calculate the `total` field.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadata","description":""},"com.wixpress.badges.v3.QueryBadgesRequest":{"type":"object","properties":{"filter":{"title":"filter","description":"Filter options.\nCurrently supported fields for filtering:\n- id\n- title\n- slug\nFor more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"title":"sort","description":"Sorting options.\nFor more details on how to use sorting,\nsee [API Query Language: The Sort Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-sort-section)","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Pagination options. For more information, see\n[API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryBadgesRequest","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Name of the field to sort by.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order.","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.badges.v3.QueryBadgesResponse":{"type":"object","properties":{"badges":{"title":"badges","description":"List of badges.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge"},"x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"$ref":"#/components/schemas/wix.common.PagingMetadata","summary":"metadata","description":"Metadata for the paginated results.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryBadgesResponse","description":""},"com.wixpress.badges.v3.GetBadgeRequest":{"type":"object","properties":{"id":{"title":"id","description":"Badge ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetBadgeRequest","description":""},"com.wixpress.badges.v3.GetBadgeResponse":{"type":"object","properties":{"badge":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge","summary":"badge","description":"Badge.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetBadgeResponse","description":""},"com.wixpress.badges.v3.DeleteBadgeRequest":{"type":"object","properties":{"id":{"title":"id","description":"Badge ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteBadgeRequest","description":""},"com.wixpress.badges.v3.DeleteBadgeResponse":{"type":"object","properties":{},"title":"DeleteBadgeResponse","description":""},"com.wixpress.badges.v3.CountBadgesRequest":{"type":"object","properties":{"filter":{"title":"filter","description":"Filter options.\nCurrently supported fields for filtering:\n- id\n- title\n- slug\nFor more details on how to use filter, see [API Query Language: The Filter Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section).","type":"object","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CountBadgesRequest","description":""},"com.wixpress.badges.v3.CountBadgesResponse":{"type":"object","properties":{"count":{"title":"count","description":"Badge count.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CountBadgesResponse","description":""},"com.wixpress.badges.v3.AssignBadgeRequest":{"type":"object","properties":{"id":{"title":"id","description":"Badge ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"memberIds":{"title":"memberIds","description":"List of member IDs to assign to the badge.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AssignBadgeRequest","description":""},"com.wixpress.badges.v3.AssignBadgeResponse":{"type":"object","properties":{"memberIds":{"title":"memberIds","description":"List of member IDs assigned to the badge.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AssignBadgeResponse","description":""},"com.wixpress.badges.v3.BadgeAssigned":{"type":"object","properties":{"memberId":{"title":"memberId","description":"ID of the member who received the badge.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BadgeAssigned","description":""},"com.wixpress.badges.v3.AssignBadgesRequest":{"type":"object","properties":{"ids":{"title":"ids","description":"List of badge IDs to assign to the member.","format":"GUID","minItems":1,"maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"memberId":{"title":"memberId","description":"Member ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AssignBadgesRequest","description":""},"com.wixpress.badges.v3.AssignBadgesResponse":{"type":"object","properties":{"ids":{"title":"ids","description":"List of badge IDs newly assigned to the member.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AssignBadgesResponse","description":""},"com.wixpress.badges.v3.UnassignBadgeRequest":{"type":"object","properties":{"id":{"title":"id","description":"Badge ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"memberIds":{"title":"memberIds","description":"List of members to remove.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UnassignBadgeRequest","description":""},"com.wixpress.badges.v3.UnassignBadgeResponse":{"type":"object","properties":{},"title":"UnassignBadgeResponse","description":""},"com.wixpress.badges.v3.BadgeUnassigned":{"type":"object","properties":{"memberId":{"title":"memberId","description":"ID of the member who lost the badge.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BadgeUnassigned","description":""},"com.wixpress.badges.v3.ListMembersRequest":{"type":"object","properties":{"id":{"title":"id","description":"Badge ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Pagination options. For more information, see\n[API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListMembersRequest","description":""},"com.wixpress.badges.v3.ListMembersResponse":{"type":"object","properties":{"memberIds":{"title":"memberIds","description":"Member IDs assigned to the badge.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"$ref":"#/components/schemas/wix.common.PagingMetadata","summary":"metadata","description":"Metadata for the paginated results.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListMembersResponse","description":""},"com.wixpress.badges.v3.ListMembersBadgeIdsRequest":{"type":"object","properties":{"memberIds":{"title":"memberIds","description":"List of members.","format":"GUID","minItems":1,"maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListMembersBadgeIdsRequest","description":""},"com.wixpress.badges.v3.ListMembersBadgeIdsResponse":{"type":"object","properties":{"memberBadgeIds":{"title":"memberBadgeIds","description":"List of members and the badges they're assigned to.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.badges.v3.MemberBadgeIds"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListMembersBadgeIdsResponse","description":""},"com.wixpress.badges.v3.MemberBadgeIds":{"type":"object","properties":{"memberId":{"title":"memberId","description":"Member ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"badgeIds":{"title":"badgeIds","description":"List of badges the member is assigned to.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"MemberBadgeIds","description":""},"com.wixpress.badges.v3.GetMemberCountsPerBadgeRequest":{"type":"object","properties":{},"title":"GetMemberCountsPerBadgeRequest","description":""},"com.wixpress.badges.v3.GetMemberCountsPerBadgeResponse":{"type":"object","properties":{"badgeMemberCounts":{"title":"badgeMemberCounts","description":"List of badges and counts of members who have each badge.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.badges.v3.BadgeMemberCount"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetMemberCountsPerBadgeResponse","description":""},"com.wixpress.badges.v3.BadgeMemberCount":{"type":"object","properties":{"badgeId":{"title":"badgeId","description":"Badge ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"memberCount":{"title":"memberCount","description":"Badge member count.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BadgeMemberCount","description":""},"com.wixpress.badges.v3.UpdateBadgesDisplayOrderRequest":{"type":"object","properties":{"badgeIds":{"title":"badgeIds","description":"Ordered badge IDs.","format":"GUID","minItems":1,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateBadgesDisplayOrderRequest","description":""},"com.wixpress.badges.v3.UpdateBadgesDisplayOrderResponse":{"type":"object","properties":{"badges":{"title":"badges","description":"Reordered badges list.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.badges.v3.Badge"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateBadgesDisplayOrderResponse","description":""}}},"title":"Badge","description":"","fqdn":"wix.badges.v3.badge"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Badges\n\nThe Badges API enables site owners to create badges on their website or Wix App, and assign them to site members, either from their site dashboard, or from their live site. Badges are set up by site owners in their site dashboard. Wix does not provide preset badges.\n\nBadges assigned to specific site members help them stand out from other members. You can use badges to create specific categories of members within your site.\n\nWith the Badges API, third-party developers can customize how badges are created and assigned, including, for example, automating creation of specific categories of members who will recieve a given badge, or delegating assignment of badges to site members themselves.\n\nFor an overview of badges, see [About Member Badges](https://support.wix.com/en/article/about-member-badges).\n\n## Terminology\n\n - **Badge:** a visible label to be displayed on a site member's profile. A badge has a name (mandatory), an icon, and a background color.\n\n## Badge Permissions\nBadges can grant site members special permissions to access specific pages.\n\nSite owners can [set badge permissions](https://support.wix.com/en/article/setting-permissions-for-a-member-badge) in the Site Members area of the dashboard.\n\nBadge permissions can't be set in the API.\n\nSite members receive permissions once a permission-granting badge is assigned to them.\n\n## Use cases\n\n**Auto assign badges for the most active members.** A third party developer wants to create a loyalty program app that auto assigns badges to members, based on their activities.\n\n * Required information\n * Retrieve member IDs from the [Site members API](https://dev.wix.com/api/rest/members/members/about-wix-members), using the [List Members endpoint](https://dev.wix.com/api/rest/members/members/list-members) to get a full list of all members.\n * Select relevant members, based on e.g. activities, orders list / bookings etc. by looking up the member IDs in the [stores API](https://dev.wix.com/api/rest/wix-stores/about-wix-stores) / [bookings APIs](https://dev.wix.com/api/rest/wix-bookings/about-wix-bookings)):\n * To select members with a long store order history, you may wish to retrieve all orders with the [Query Orders endpoint](https://dev.wix.com/api/rest/wix-stores/orders/query-orders), filtering by `buyerInfo.id`. Retrieving a list of all orders, e.g. with an empty query filter, may include buyers who are site contacts, but not site members.\n * To select members who actively book services, you may wish to use the [Query Bookings endpoint](https://dev.wix.com/api/rest/wix-bookings/bookings/bookings-reader/query-bookings) and include the `contactId` of each member retrieved from the Site Members API.\n\n * Steps\n 1. Define member group according to site owner's needs\n 2. Get currently eligible members using other APIs\n 3. Create badge using the [Create badge endpoint](https://dev.wix.com/api/rest/members/badges/create-badge)\n 4. Assign badge using the [Assign badge to members endpoint](https://dev.wix.com/api/rest/members/badges/assign-badge-to-members)\n\n**Allow site members to assign badges to other members.** A third party developer wants to create a community in which members can assign badges to one another and see available badges. For example, a site admin member may want to give certain site members access to a permissioned, \"staff only\" page on their site.\n\n * Required information\n * Member's details (Site members API)\n\n * Steps\n 1. Get all available badges on site, to display to the user for assignment, using [List badges endpoint](https://dev.wix.com/api/rest/members/badges/list-badges)\n 2. Select the permissioned, \"staff only\" badge from the list. The badge must already exist, created with permissions added by the site owner.\n 3. Assign badge to selected members, based on user input, using the [Assign badge to members endpoint](https://dev.wix.com/api/rest/members/badges/assign-badge-to-members)\n 4. Show updated listing of member's badges using the [List badges per member endpoint](https://dev.wix.com/api/rest/members/badges/list-badges-per-member)\n\n## Limitations\n\nMember permissions themselves cannot be managed via the badges API. They must be set by the site owner in the site's dashboard.\n"}]},"reviewStatus":"APPROVED","isLocked":true}

Create Badge

Permission Scopes