Privacy and analytics

We use necessary technical cookies and, only with your consent, analytics and marketing pixels to improve the website and measure campaigns.

Privacy policyCookie policy
Docs
English
EspañolEnglishFrançaisDeutschItalianoPortuguês

Getting started

  • What is Nömad?
  • Getting started with Nömad
  • Create your brand and complete the Genome
  • Invite your team
  • Glossary

Brand OS

  • What is inside Brand OS
  • What is the Genome?
  • Who is Nödo?
  • What does a Brand Manager do?
  • Brand Kit and Library
  • Posts and calendar
  • Connections
  • Meetings

Work

  • Work and tasks
  • Ordering work
  • Following, reviewing and approving deliveries
  • Custom quotes
  • Yes, there are humans behind it

Account and billing

  • Plans and pricing
  • Billing and payments
  • Roles and permissions
  • Workspaces and multiple brands
  • Languages, apps and data

Help

  • How to get help

API

  • Brand API
    • Permissions and roles
    • Brand
    • Genome
    • Brand Kit
    • Library
    • Works
    • Calendar
    • Connections
    • Publishing
    • Inbox
    • Team
    • Conversation
    • Memory
    • Questions
    • Media
    • Store
    • Plan
    • Orders
    • Activity

MCP

  • MCP server

Connectors

  • Brand connectors

Nödo and agents

  • Nödo in the brand
API/Brand API
Reference3 min read

Brand

Entry point, profile, contact and soul.

On this page
  • brand.overview · Enter the brand
  • brand.soul.read · Read the brand soul
  • brand.profile.update · Update the profile
  • brand.contacts.list · Contact and social
Русский
한국어
日本語
中文
हिन्दी
Open the app
brand.contacts.save · Save a channel

brand.overview · Enter the brand

Call first in every conversation. Returns the brand name and short id, plan, Brand Manager, active work and pending task counts, and the capabilities the caller may use in this brand.

FieldValue
KindRead
HTTP methodPOST /api/v1/brand.overview
MCP toolbrand_overview
Scopebrand.read
Minimum roleViewer
Human confirmationNo
DoorsNödo, Voice, MCP, API
StatusPlanned
Widgetrecord

Input

{}

Output

{
  id: string  // uuid
  shortId: string  // Human id such as WP-121.
  name: string
  plan: string | null
  manager: {
    id: string  // uuid
    name: string
    avatarUrl: string | null
  }
  | null
  counts: {
    activeWorks: integer  // -9007199254740991–9007199254740991
    pendingTasks: integer  // -9007199254740991–9007199254740991
    pendingMemory: integer  // -9007199254740991–9007199254740991
  }
  role: string | null  // Brand role of the caller, or null for staff.
  capabilities: string[]  // Capability ids the caller may use here.
}

brand.soul.read · Read the brand soul

The brand voice compiled from the accepted Genome: tone, archetypes, vocabulary, guardrails, locales and on/off-brand examples. Use it before writing or creating anything on behalf of the brand; missing sections are listed in gaps so you ask instead of guessing.

FieldValue
KindRead
HTTP methodPOST /api/v1/brand.soul.read
MCP toolbrand_soul_read
Scopebrand.read
Minimum roleViewer
Human confirmationNo
DoorsNödo, Voice, MCP, API
StatusPlanned

Input

{}

Output

{
  revision: integer  // -9007199254740991–9007199254740991
  genomeRevision: integer  // -9007199254740991–9007199254740991 · Accepted Genome revision it was compiled from.
  compiledAt: string
  voice: {
    summary: string  // ≤ 600
    tone: Array<{
      axis: string
      position: number  // -2–2
    }>  // ≤ 6 items · e.g. formal(-2)…casual(+2).
    traits: string[]  // ≤ 8 items
    archetypes: string[]  // ≤ 3 items
  }
  vocabulary: {
    use: string[]  // ≤ 30 items
    avoid: string[]  // ≤ 30 items
  }
  guardrails: string[]  // ≤ 15 items
  audiences: string[]  // ≤ 6 items
  locales: Array<{
    locale: string
    notes: string  // ≤ 300
  }>  // ≤ 8 items
  examples: Array<{
    onBrand: string
    offBrand: string
  }>  // ≤ 10 items
  gaps: string[]  // Genome sections missing or unaccepted; Nödo asks instead of guessing.
}

brand.profile.update · Update the profile

Changes display name, country, city, organization type or primary language. Written to the Genome with an optimistic revision check; send the revision from brand.overview or genome.read.

FieldValue
KindWrite
HTTP methodPOST /api/v1/brand.profile.update
MCP toolbrand_profile_update
Scopebrand.write
Minimum roleAdmin
Human confirmationYes
DoorsNödo, MCP, API
StatusPlanned
Widgetconfirm

Input

{
  expectedRevision: integer  // -9007199254740991–9007199254740991
  displayName?: string  // ≤ 120
  countryCode?: string  // ≤ 2
  city?: string  // ≤ 120
  organizationType?: string  // ≤ 40
  primaryLanguage?: string  // ≤ 12
}

Output

{
  ok: true
  id?: string
  revision?: integer  // -9007199254740991–9007199254740991
}

brand.contacts.list · Contact and social

Public channels of the brand: website, email, phone and social profiles.

FieldValue
KindRead
HTTP methodPOST /api/v1/brand.contacts.list
MCP toolbrand_contacts_list
Scopebrand.read
Minimum roleAdmin
Human confirmationNo
DoorsNödo, Voice, MCP, API
StatusPlanned
Widgetlist

Input

{}

Output

{
  items: Array<{
    id: string  // uuid
    type: "website" | "email" | "phone" | "whatsapp" | "instagram" | "facebook" | "linkedin" | "tiktok" | "x" | "youtube" | "pinterest" | "other"
    value: string
    label: string | null
  }>
}

brand.contacts.save · Save a channel

Adds, changes or removes one public channel. Values are normalized and checked per type; duplicates are rejected.

FieldValue
KindWrite
HTTP methodPOST /api/v1/brand.contacts.save
MCP toolbrand_contacts_save
Scopebrand.write
Minimum roleAdmin
Human confirmationYes
DoorsNödo, MCP, API
StatusPlanned
Widgetconfirm

Input

{
  op: "upsert"
  id?: string  // uuid
  type: "website" | "email" | "phone" | "whatsapp" | "instagram" | "facebook" | "linkedin" | "tiktok" | "x" | "youtube" | "pinterest" | "other"
  value: string  // ≤ 500
  label?: string  // ≤ 80
}
| {
  op: "delete"
  id: string  // uuid
}

Output

{
  ok: true
  id?: string
  revision?: integer  // -9007199254740991–9007199254740991
}

Updated on January 1, 1970

PreviousPermissions and rolesNextGenome

In this section

  • Permissions and roles
  • Genome
  • Brand Kit
  • Library
  • Works
  • Calendar
  • Connections
  • Publishing
Can't find what you need? Write to usWrite to usGo to the app
© 2026 Nömad · Nömad documentationLinkedInInstagramFacebookTikTokYouTubeX
Go to nomad.oooBack to top

On this page

  • brand.overview · Enter the brand
  • brand.soul.read · Read the brand soul
  • brand.profile.update · Update the profile
  • brand.contacts.list · Contact and social
  • brand.contacts.save · Save a channel