Page MenuHomeSoftware Heritage
Conduit badge.edit

badge.edit

API Method: badge.edit

Login Required: This method requires authentication. You must log in before you can make calls to it.
Returns
map<string, wild>
Errors
  • ERR-CONDUIT-CORE: See error message for details.
OAuth Scope
OAuth clients may never call this method.
Description

This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.

Transaction Types

This endpoint supports these types of transactions. See below for detailed information about each transaction type.

KeyDescription
nameBadge name.
flavorShort description of the badge.
iconChange the badge icon.
qualityColor and rarity of the badge.
descriptionBadge long description.
awardNew badge award recipients.
revokeRevoke badge award recipients.
editChange the edit policy of the object.
subscribers.addAdd subscribers.
subscribers.removeRemove subscribers.
subscribers.setSet subscribers, overwriting current value.
commentMake comments.
mfaSign this transaction group with MFA.

Transaction Type: name

Badge name.

KeyTypeDescription
typeconstname
valuestringNew badge name.

Transaction Type: flavor

Short description of the badge.

KeyTypeDescription
typeconstflavor
valuestringNew badge flavor.

Transaction Type: icon

Change the badge icon.

KeyTypeDescription
typeconsticon
valuestringNew badge icon.

Transaction Type: quality

Color and rarity of the badge.

KeyTypeDescription
typeconstquality
valuestringNew badge quality.

Transaction Type: description

Badge long description.

KeyTypeDescription
typeconstdescription
valuestringNew badge description.

Transaction Type: award

New badge award recipients.

KeyTypeDescription
typeconstaward
valuelist<phid>New badge award recipients.

Transaction Type: revoke

Revoke badge award recipients.

KeyTypeDescription
typeconstrevoke
valuelist<phid>Revoke badge award recipients.

Transaction Type: edit

Change the edit policy of the object.

KeyTypeDescription
typeconstedit
valuestringNew policy PHID or constant.

Transaction Type: subscribers.add

Add subscribers.

KeyTypeDescription
typeconstsubscribers.add
valuelist<user>List of PHIDs to add.

Transaction Type: subscribers.remove

Remove subscribers.

KeyTypeDescription
typeconstsubscribers.remove
valuelist<user>List of PHIDs to remove.

Transaction Type: subscribers.set

Set subscribers, overwriting current value.

KeyTypeDescription
typeconstsubscribers.set
valuelist<user>List of PHIDs to set.

Transaction Type: comment

Make comments.

KeyTypeDescription
typeconstcomment
valuestringComment to add, formatted as remarkup.

Transaction Type: mfa

Sign this transaction group with MFA.

KeyTypeDescription
typeconstmfa
valuebool

Call Method

Enter parameters using JSON. For instance, to enter a list, type: ["apple", "banana", "cherry"]

list<map<string, wild>>
optional id|phid|string

Examples

  • Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
  • If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://forge.softwareheritage.org/ --conduit-token <conduit-token> -- badge.edit
About · Developer information · Legal