Neynar Documentation
Invite
cURL
curl --request POST \
--url https://api.neynar.com/v2/farcaster/channel/member/invite/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: NEYNAR_API_DOCS' \
--data '
{
"channel_id": "neynar",
"fid": 3,
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"
}
'```
### Python
import requests
url = "https://api.neynar.com/v2/farcaster/channel/member/invite/"
payload = { "channel_id": "neynar", "fid": 3, "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec" } headers = { "x-api-key": "NEYNAR_API_DOCS", "Content-Type": "application/json" }
response = requests.post(url, json=payload, headers=headers)
print(response.text)
### JavaScript
const options = { method: 'POST', headers: {'x-api-key': 'NEYNAR_API_DOCS', 'Content-Type': 'application/json'}, body: JSON.stringify({ channel_id: 'neynar', fid: 3, signer_uuid: '19d0c5fd-9b33-4a48-a0e2-bc7b0555baec' }) };
fetch('https://api.neynar.com/v2/farcaster/channel/member/invite/', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));
### PHP
"https://api.neynar.com/v2/farcaster/channel/member/invite/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'channel_id' => 'neynar',
'fid' => 3,
'signer_uuid' => '19d0c5fd-9b33-4a48-a0e2-bc7b0555baec'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: NEYNAR_API_DOCS"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
### Go
package main
import ( "fmt" "strings" "net/http" "io" )
func main() {
url := "https://api.neynar.com/v2/farcaster/channel/member/invite/"
payload := strings.NewReader("{\n "channel_id": "neynar",\n "fid": 3,\n "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "NEYNAR_API_DOCS") req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(string(body)) }
### Java
HttpResponse
### Ruby
require 'uri' require 'net/http'
url = URI("https://api.neynar.com/v2/farcaster/channel/member/invite/")
http = Net::HTTP.new(url.host, url.port) http.use_ssl = true
request = Net::HTTP::Post.new(url) request["x-api-key"] = 'NEYNAR_API_DOCS' request["Content-Type"] = 'application/json' request.body = "{\n "channel_id": "neynar",\n "fid": 3,\n "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec"}\n"
response = http.request(request) puts response.read_body
### Responses
**200**
```json
{
"message": "<string>",
"success": true
}
400
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}
500
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}
Authorizations
x-api-key
- Type: string
- Location: header
- Required: Yes
- Default: NEYNAR_API_DOCS
Body
- channel_id: The unique identifier of a farcaster channel (string, required)
- fid: The unique identifier of a farcaster user or app (integer, required)
- signer_uuid: UUID of the signer (string, required)