`["invite", "use"]`

Description

This request is related to redeeming pub invites.

The primary documentation for this request is the Scuttlebutt Protocol Guide.

Name	["invite", "use"]
Type	"async"
Args	Must be an array containing exactly one object.

The object within the args array must have the following schema:

Field name	Required	Type	Description
feed	true	string	Id of the feed in the at-sign feed id format.

The response is a JSON object which describes the follow message which the pub published in its feed. The response must have the following schema:

Field name	Required	Type	Description
key	true	string	Id of the message in the percent-sign message id format.
value	true	object	JSON object which is the raw message which the pub published to its feed. Note: it is unclear what happens for feed formats other than the default feed format.

Field name

Required

Type

Description

key

true

string

Id of the message in the percent-sign message id format.

value

true

object

JSON object which is the raw message which the pub published to its feed.

Note: it is unclear what happens for feed formats other than the default feed format.

Notes:

This response format is similar to the format which is used in responses to ["createHistoryStream"] requests.