Return whether a sender may start/continue a conversation with a recipient, based on the recipient's chatPrefs and the follow relationship. Used by the server-side start gate.
Parameters
Output
Encoding
application/jsonallow
string
Required
No description available.
bucket
string
Optional
No description available.
mutuals
boolean
Required
No description available.
permitted
boolean
Required
No description available.
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Return whether a sender may start/continue a conversation with a recipient, based on the recipient's chatPrefs and the follow relationship. Used by the server-side start gate.",
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"allow": {
"enum": [
"off",
"mutuals",
"everyone"
],
"type": "string"
},
"bucket": {
"enum": [
"inbox",
"requests"
],
"type": "string"
},
"mutuals": {
"type": "boolean"
},
"permitted": {
"type": "boolean"
}
},
"required": [
"allow",
"mutuals",
"permitted"
],
"type": "object"
}
},
"parameters": {
"properties": {
"recipient": {
"format": "did",
"type": "string"
},
"sender": {
"format": "did",
"type": "string"
}
},
"required": [
"sender",
"recipient"
],
"type": "params"
},
"type": "query"
}