PUT
/
farcaster
/
channel
/
member
/
invite
curl --request PUT \
  --url https://api.neynar.com/v2/farcaster/channel/member/invite \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
  "channel_id": "neynar",
  "role": "member",
  "accept": true
}'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Body

application/json
​
signer_uuid
string
required

UUID of the signer. signer_uuid is paired with API key, can't use a uuid made with a different API key.

Example:

"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"

​
channel_id
string
required

The unique identifier of a farcaster channel

Example:

"neynar"

​
role
enum<string>
required

The role of a channel member

Available options:
member,
moderator
​
accept
boolean
required

Accept or reject the invite

Response

200
application/json
Successful operation.
​
success
boolean
​
message
string

Was this page helpful?