Skip to main content
PATCH
/
v2
/
farcaster
/
user
/
Update user profile
curl --request PATCH \
  --url https://api.neynar.com/v2/farcaster/user/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
  "banner": "<string>",
  "bio": "<string>",
  "display_name": "<string>",
  "pfp_url": "<string>",
  "primary_eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
  "primary_sol_address": "<string>",
  "url": "<string>",
  "username": "<string>",
  "verified_accounts": {
    "github": "<string>",
    "x": "<string>"
  }
}
'
import requests

url = "https://api.neynar.com/v2/farcaster/user/"

payload = {
"signer_uuid": "19d0c5fd-9b33-4a48-a0e2-bc7b0555baec",
"banner": "<string>",
"bio": "<string>",
"display_name": "<string>",
"pfp_url": "<string>",
"primary_eth_address": "0x5a927ac639636e534b678e81768ca19e2c6280b7",
"primary_sol_address": "<string>",
"url": "<string>",
"username": "<string>",
"verified_accounts": {
"github": "<string>",
"x": "<string>"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
signer_uuid: '19d0c5fd-9b33-4a48-a0e2-bc7b0555baec',
banner: '<string>',
bio: '<string>',
display_name: '<string>',
pfp_url: '<string>',
primary_eth_address: '0x5a927ac639636e534b678e81768ca19e2c6280b7',
primary_sol_address: '<string>',
url: '<string>',
username: '<string>',
verified_accounts: {github: '<string>', x: '<string>'}
})
};

fetch('https://api.neynar.com/v2/farcaster/user/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.neynar.com/v2/farcaster/user/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'signer_uuid' => '19d0c5fd-9b33-4a48-a0e2-bc7b0555baec',
'banner' => '<string>',
'bio' => '<string>',
'display_name' => '<string>',
'pfp_url' => '<string>',
'primary_eth_address' => '0x5a927ac639636e534b678e81768ca19e2c6280b7',
'primary_sol_address' => '<string>',
'url' => '<string>',
'username' => '<string>',
'verified_accounts' => [
'github' => '<string>',
'x' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.neynar.com/v2/farcaster/user/"

payload := strings.NewReader("{\n \"signer_uuid\": \"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec\",\n \"banner\": \"<string>\",\n \"bio\": \"<string>\",\n \"display_name\": \"<string>\",\n \"pfp_url\": \"<string>\",\n \"primary_eth_address\": \"0x5a927ac639636e534b678e81768ca19e2c6280b7\",\n \"primary_sol_address\": \"<string>\",\n \"url\": \"<string>\",\n \"username\": \"<string>\",\n \"verified_accounts\": {\n \"github\": \"<string>\",\n \"x\": \"<string>\"\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("x-api-key", "<api-key>")
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))

}
HttpResponse<String> response = Unirest.patch("https://api.neynar.com/v2/farcaster/user/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"signer_uuid\": \"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec\",\n \"banner\": \"<string>\",\n \"bio\": \"<string>\",\n \"display_name\": \"<string>\",\n \"pfp_url\": \"<string>\",\n \"primary_eth_address\": \"0x5a927ac639636e534b678e81768ca19e2c6280b7\",\n \"primary_sol_address\": \"<string>\",\n \"url\": \"<string>\",\n \"username\": \"<string>\",\n \"verified_accounts\": {\n \"github\": \"<string>\",\n \"x\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/user/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"signer_uuid\": \"19d0c5fd-9b33-4a48-a0e2-bc7b0555baec\",\n \"banner\": \"<string>\",\n \"bio\": \"<string>\",\n \"display_name\": \"<string>\",\n \"pfp_url\": \"<string>\",\n \"primary_eth_address\": \"0x5a927ac639636e534b678e81768ca19e2c6280b7\",\n \"primary_sol_address\": \"<string>\",\n \"url\": \"<string>\",\n \"username\": \"<string>\",\n \"verified_accounts\": {\n \"github\": \"<string>\",\n \"x\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "message": "<string>",
  "success": true
}
{
"errors": [
{
"message": "<string>"
}
],
"success": true
}
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"status": 123
}

Node.js SDK

šŸ”— SDK Method: updateUser Use this API endpoint with the Neynar Node.js SDK for typed responses and better developer experience.

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"

banner
string

Requires pro subscription.

bio
string
display_name
string
location
object
pfp_url
string
primary_eth_address
string

Must be one of the verified addresses.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x5a927ac639636e534b678e81768ca19e2c6280b7"

primary_sol_address
string

Must be one of the verified addresses.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
url
string
username
string
verified_accounts
object

Response

Success

message
string
success
boolean