Neynar Documentation

Assign a custom subdomain to a deployed miniapp

Group: Studio APIs

Use this when you need: Assign a custom subdomain to a deployed miniapp.

Usage

    import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";

const client = new NeynarAPIClient(
      new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
    );

const res = await client.assignCustomDomain({
      fid: 123, // Farcaster ID of the requesting user
      assignCustomDomainRequest: "value", // required
    });
    console.log(res);
    ```

## Parameters

| Parameter                     | Type                        | Required | Description                                   |
|-------------------------------|-----------------------------|----------|-----------------------------------------------|
| `fid`                         | `number`                   | ✅       | Farcaster ID of the requesting user          |
| `assignCustomDomainRequest`   | `AssignCustomDomainRequest` | ✅       | -                                             |

## Response

Returns a `RequestArgs` object.

## Error Handling

try {
  const res = await client.assignCustomDomain({
    fid: 123,
    assignCustomDomainRequest: "value"
  });
  // use res
} catch (err) {
  // Axios/HTTP errors, invalid params, auth issues, etc.
  console.error(err);
}
```

Tips

• Provide a viewerFid when supported to respect mutes/blocks and include viewer_context.
• Keep requests scoped (e.g., use limit) to improve latency.
• Cache results where sensible.