users

Setup User

post/users/setup

Request

  • Base URL: https://api.iridiumhqmcp.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.iridiumhqmcp.com/users/setup
  • Auth: HTTP bearer

Request body

current_rolestring nullable

The user's role and company, e.g. 'Founder at Acme'.

credential_leadstring nullable

One or two sentences on why the user is credible. Opens outreach messages.

networking_goalstring nullable

What the user wants from the people they reach, e.g. 'find design partners'.

outreach_intentstring nullable

Message strategy: 'sell', 'connection' or 'referral'.

style_examplesstring[] nullable

Up to 3 approved note texts to imitate.

target_personasstring[] nullable

Job titles to search for, e.g. ['VP of Engineering', 'Founder'].

search_keywordsstring[] nullable

Keywords searched alongside the personas, e.g. ['AI platform'].

target_citiesstring[] nullable

Cities to search in, e.g. ['San Francisco', 'New York'].

target_countriesstring[] nullable

Countries to search in, e.g. ['United States'].

daily_outreach_capinteger nullable

Connection requests per day, clamped to 25.

comment_topicsstring[] nullable

Subjects searched when finding posts to comment on.

daily_comment_capinteger nullable

Comments per day, clamped to 25.

network_post_pctinteger nullable

Percent of comments sourced from in-network posts; the rest come from keyword search.

new_position_pctinteger nullable

Percent of the daily cap allowed for new-role announcement posts.

comment_author_countriesstring[] nullable

Only comment on posts by authors in these countries. Empty means no filter.

filter_cert_postsboolean nullable

Skip 'I just earned/completed/certified' posts.

filter_hiring_postsboolean nullable

Skip 'we're hiring / open role' posts.

filter_job_seeking_postsboolean nullable

Skip 'open to work / looking for my next role' posts.

comment_hiring_onlyboolean nullable

Only comment on posts tagged #hiring — opt-in, the inverse of filter_hiring_posts.

content_topicsstring[] nullable

Subjects the user's own posts are drafted about.

voice_dnastring nullable

Writing rules applied to every draft, e.g. 'no buzzwords, direct, max 2 sentences'.

onboarding_goalsstring[] nullable

Which pipelines are active. Any of ['commenting', 'content', 'outreach'].

data_retention_daysinteger nullable

Days before scraped profiles and drafts are purged.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.