Skip to main content
POST
/
v2
/
farcaster
/
channel
/
member
/
invite
Invite
curl --request POST \
  --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",
  "fid": 3,
  "role": "member"
}
'
{
  "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"

​
fid
integer<int32>
required

The unique identifier of a farcaster user or app (unsigned integer)

Required range: x >= 0
Example:

3

​
role
enum<string>
required

The role of a channel member

Available options:
member,
moderator,
owner

Response

Success

​
success
boolean
​
message
string