User Badge Revoke

Request Details

Item Value
Description

Requests the removal of a badge from a member.
Method PUT
Endpoint https://[environment]api[client_id].crowdtwist.com/v2.1/users/[user_id]/badges? api_key=[api_key]&id_type=[id_type]
Content Type application/json

Request Query Parameters

Field Name Sample Value Required Format Description
api_key QWERTYP Yes String

Client-configured API key.
user_id user@crowdtwist.com Yes String ID of the user.
id_type Email No String

Type of ID being sent:

  • email

  • facebook_user_id

  • twitter_user_id

  • id (CrowdTwist ID) – default ID if id_type is not specified

  • third_party_id

  • username

  • mobile_phone_number

Request Body

Field Name Sample Value Required Format Description
badge_id 123456 Yes Integer

ID of the badge to be removed.
earn_id   No Integer The specific earn_id to be removed. If not provided, the first earned badge is removed.
custom_data   No JSON array

Client-defined custom data.

Sample Request Body

{ "badge_id": 12345, "earn_id": 345, "custom_data": { "customer_variable" : "customer data" } }