ycli forms¶

Yandex Forms: surveys, questions, answers, publishing.

Usage:

$ ycli forms [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• auth: Check that the token works for forms.
• me: Forms authenticated user.
• surveys: Forms surveys.
• questions: Forms questions.
• conditions: Forms display (show) conditions.
• access: Forms survey permissions.
• history: Forms change log.
• answers: Forms answers.
• keysets: Forms personal-link key sets.
• operations: Forms async operations.
• notifications: Forms integration runs (notifications).
• files: Forms form-filling file storage.
• images: Forms images.
• filling: Forms form filling.
• hooks: Forms integration groups (hooks).
• subscriptions: Forms integrations of an integration group.
• variables: Variables available to a form's integrations.

ycli forms auth¶

Check that the token works for forms.

Usage:

$ ycli forms auth [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• status: Probe forms with its own read; exit 1 when...

ycli forms auth status¶

Probe forms with its own read; exit 1 when the token is rejected.

Usage:

$ ycli forms auth status [OPTIONS]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms me¶

Forms authenticated user.

Usage:

$ ycli forms me [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print the authenticated user (a safe auth...

ycli forms me get¶

Print the authenticated user (a safe auth probe).

Usage:

$ ycli forms me get [OPTIONS]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms surveys¶

Forms surveys.

Usage:

$ ycli forms surveys [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List forms, filtered (auto-paginated over...
• get: Print one form's settings for SURVEY_ID.
• create: Create a form (POST /surveys).
• update: Modify form SURVEY_ID (PATCH...
• delete: Delete form SURVEY_ID (DELETE /surveys/{id}).
• publish: Publish form SURVEY_ID (POST...
• unpublish: Unpublish form SURVEY_ID (POST...

ycli forms surveys list¶

List forms, filtered (auto-paginated over offset pages; --all for everything).

Usage:

$ ycli forms surveys list [OPTIONS]

Options:

• --limit INTEGER RANGE: Max items to fetch; 0 uses the default cap. [default: 0; x>=0]
• --all: Fetch everything, ignoring the cap.
• --name TEXT: Only forms whose name matches.
• --published / --no-published: Only published (or only unpublished).
• --ownership TEXT: mine (created by you) or shared (open to you).
• --group TEXT: Only forms of this group.
• --favourite / --no-favourite: Only favourites (or only the others).
• --show-all: As an administrator, every form of the organization.
• --orderby TEXT: Sort, e.g. name,-modified,-count.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms surveys get¶

Print one form's settings for SURVEY_ID.

Usage:

$ ycli forms surveys get [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms surveys create¶

Create a form (POST /surveys). Advanced keys via --field; returns the created form.

Usage:

$ ycli forms surveys create [OPTIONS]

Options:

• --name TEXT: Form name (title). [required]
• --language TEXT: Ignored by the API: the reply reports the language, a request cannot set it.
• --published / --no-published: Ignored by the API: publish a form with surveys publish instead.
• --public / --no-public: Ignored by the API: the reply reports whether the form is public, a request cannot set it.
• --need-auth / --no-need-auth: Require sign-in to fill.
• --max-count INTEGER: Maximum number of responses (0 = unset). [default: 0]
• -F, --field TEXT: Advanced key=value (JSON-coerced; repeatable).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms surveys update¶

Modify form SURVEY_ID (PATCH /surveys/{id}) — only supplied fields are sent.

Usage:

$ ycli forms surveys update [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --name TEXT: New form name.
• --language TEXT: Ignored by the API: the reply reports the language, a request cannot set it.
• --published / --no-published: Ignored by the API: publish a form with surveys publish instead.
• --public / --no-public: Ignored by the API: the reply reports whether the form is public, a request cannot set it.
• --need-auth / --no-need-auth: Toggle sign-in requirement.
• --max-count INTEGER: New response cap (0 = leave unchanged). [default: 0]
• -F, --field TEXT: Advanced key=value (JSON-coerced; repeatable).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms surveys delete¶

Delete form SURVEY_ID (DELETE /surveys/{id}).

Usage:

$ ycli forms surveys delete [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms surveys publish¶

Publish form SURVEY_ID (POST /surveys/{id}/publish).

Usage:

$ ycli forms surveys publish [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms surveys unpublish¶

Unpublish form SURVEY_ID (POST /surveys/{id}/unpublish).

Usage:

$ ycli forms surveys unpublish [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms questions¶

Forms questions.

Usage:

$ ycli forms questions [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List a form's questions (the {pages}...
• get: Print one question's settings (SURVEY_ID /...
• create: Create a question (POST …/questions).
• update: Modify a question (PATCH …/questions/{id})...
• delete: Delete a question (DELETE...
• move: Move a question (POST...

ycli forms questions list¶

List a form's questions (the {pages} envelope).

Usage:

$ ycli forms questions list [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms questions get¶

Print one question's settings (SURVEY_ID / QUESTION_ID).

Usage:

$ ycli forms questions get [OPTIONS] SURVEY_ID QUESTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]

Options:

• --with-slugs: Refer to other questions by slug, not id.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms questions create¶

Create a question (POST …/questions). Use --type + flags, or --body-file for full JSON.

Usage:

$ ycli forms questions create [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --type TEXT: Question type: string/boolean/integer/date/enum.
• --label TEXT: Question label / title.
• --slug TEXT: Stable machine slug.
• --comment TEXT: Question hint / helper text.
• --placeholder TEXT: Placeholder text.
• --required / --no-required: Answer required or not (sets the whole validators list: [required] or []).
• --hidden / --no-hidden: Hide until conditions match.
• --multiline / --no-multiline: Multiline text (string type).
• --widget TEXT: Enum widget: radio/checkbox/dropdown/stars/onerow.
• --option TEXT: Enum option label (repeatable).
• --body-file PATH: JSON file with the full question body (validated through the typed union); use for matrix/series/suggest/payment/daterange.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms questions update¶

Modify a question (PATCH …/questions/{id}) — --type + flags, or --body-file for full JSON.

Usage:

$ ycli forms questions update [OPTIONS] SURVEY_ID QUESTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]

Options:

• --type TEXT: Question type: string/boolean/integer/date/enum.
• --label TEXT: Question label / title.
• --slug TEXT: Stable machine slug.
• --comment TEXT: Question hint / helper text.
• --placeholder TEXT: Placeholder text.
• --required / --no-required: Answer required or not (sets the whole validators list: [required] or []).
• --hidden / --no-hidden: Hide until conditions match.
• --multiline / --no-multiline: Multiline text (string type).
• --widget TEXT: Enum widget: radio/checkbox/dropdown/stars/onerow.
• --option TEXT: Enum option label (repeatable).
• --body-file PATH: JSON file with the full question body (validated through the typed union); use for matrix/series/suggest/payment/daterange.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms questions delete¶

Delete a question (DELETE …/questions/{id}); one a condition refers to is refused.

Usage:

$ ycli forms questions delete [OPTIONS] SURVEY_ID QUESTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]

Options:

• --force: Ignored by the API: a question that a display condition refers to is refused all the same.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms questions move¶

Move a question (POST …/questions/{id}/move) to another page / position.

--position without a page target would be silently ignored by the API (200, nothing moves) — and QuestionMove now raises rather than guessing, so --page explicitly defaults to 1 here when only --position is given.

Usage:

$ ycli forms questions move [OPTIONS] SURVEY_ID QUESTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]

Options:

• --page INTEGER: Target page number, 1-based (0 = unset; visibly defaults to 1 when only --position is given — the API silently ignores a bare position). [default: 0]
• --page-id INTEGER: Target page id (0 = unset). [default: 0]
• --position INTEGER: New position on the page, 1-based (0 = unset). [default: 0]
• --create-page: Create a new page for the question.
• --question TEXT: Question id/slug to move into a question series.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions¶

Forms display (show) conditions.

Usage:

$ ycli forms conditions [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• question: Question show conditions.
• page: Page show conditions.
• submit: Submit-button show conditions.
• hook: Conditions that gate an integration group.

ycli forms conditions question¶

Question show conditions.

Usage:

$ ycli forms conditions question [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List show conditions of question...
• get: Print one condition group (SURVEY_ID...
• create: Create a condition group on the question...
• update: Replace condition group CONDITION_ID...
• delete: Delete condition group CONDITION_ID...
• set-operator: Set the operator BETWEEN the question's...

ycli forms conditions question list¶

List show conditions of question QUESTION_ID (GET …/questions/{id}/conditions).

Usage:

$ ycli forms conditions question list [OPTIONS] SURVEY_ID QUESTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions question get¶

Print one condition group (SURVEY_ID QUESTION_ID CONDITION_ID).

Usage:

$ ycli forms conditions question get [OPTIONS] SURVEY_ID QUESTION_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions question create¶

Create a condition group on the question (POST …/conditions).

Usage:

$ ycli forms conditions question create [OPTIONS] SURVEY_ID QUESTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]

Options:

• --operator TEXT: Boolean operator: and | or.
• --item TEXT: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable).
• --body-file PATH: JSON file with the full {operator, items} group body.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions question update¶

Replace condition group CONDITION_ID (PATCH — the API takes the FULL group, no partial).

Usage:

$ ycli forms conditions question update [OPTIONS] SURVEY_ID QUESTION_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• --operator TEXT: Boolean operator: and | or.
• --item TEXT: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable).
• --body-file PATH: JSON file with the full {operator, items} group body.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions question delete¶

Delete condition group CONDITION_ID (DELETE — the API answers 200, no body).

Usage:

$ ycli forms conditions question delete [OPTIONS] SURVEY_ID QUESTION_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions question set-operator¶

Set the operator BETWEEN the question's condition groups (collection PATCH).

Usage:

$ ycli forms conditions question set-operator [OPTIONS] SURVEY_ID QUESTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• QUESTION_ID: Question id (integer), e.g. 17. [required]

Options:

• --operator TEXT: Boolean operator: and | or. [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions page¶

Page show conditions.

Usage:

$ ycli forms conditions page [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List show conditions of page PAGE_ID (GET...
• get: Print one condition group (SURVEY_ID...
• create: Create a condition group on the page (POST...
• update: Replace condition group CONDITION_ID...
• delete: Delete condition group CONDITION_ID...
• set-operator: Set the operator BETWEEN the page's...

ycli forms conditions page list¶

List show conditions of page PAGE_ID (GET …/pages/{id}/conditions).

Usage:

$ ycli forms conditions page list [OPTIONS] SURVEY_ID PAGE_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• PAGE_ID: Page id (integer), from questions list. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions page get¶

Print one condition group (SURVEY_ID PAGE_ID CONDITION_ID).

Usage:

$ ycli forms conditions page get [OPTIONS] SURVEY_ID PAGE_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• PAGE_ID: Page id (integer), from questions list. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions page create¶

Create a condition group on the page (POST …/conditions).

Usage:

$ ycli forms conditions page create [OPTIONS] SURVEY_ID PAGE_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• PAGE_ID: Page id (integer), from questions list. [required]

Options:

• --operator TEXT: Boolean operator: and | or.
• --item TEXT: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable).
• --body-file PATH: JSON file with the full {operator, items} group body.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions page update¶

Replace condition group CONDITION_ID (PATCH — the API takes the FULL group, no partial).

Usage:

$ ycli forms conditions page update [OPTIONS] SURVEY_ID PAGE_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• PAGE_ID: Page id (integer), from questions list. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• --operator TEXT: Boolean operator: and | or.
• --item TEXT: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable).
• --body-file PATH: JSON file with the full {operator, items} group body.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions page delete¶

Delete condition group CONDITION_ID (DELETE — the API answers 200, no body).

Usage:

$ ycli forms conditions page delete [OPTIONS] SURVEY_ID PAGE_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• PAGE_ID: Page id (integer), from questions list. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions page set-operator¶

Set the operator BETWEEN the page's condition groups (collection PATCH).

Usage:

$ ycli forms conditions page set-operator [OPTIONS] SURVEY_ID PAGE_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• PAGE_ID: Page id (integer), from questions list. [required]

Options:

• --operator TEXT: Boolean operator: and | or. [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions submit¶

Submit-button show conditions.

Usage:

$ ycli forms conditions submit [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List show conditions of the submit button...
• get: Print one condition group (SURVEY_ID...
• create: Create a condition group on the submit...
• update: Replace condition group CONDITION_ID...
• delete: Delete condition group CONDITION_ID...
• set-operator: Set the operator BETWEEN the submit...

ycli forms conditions submit list¶

List show conditions of the submit button (GET /surveys/{id}/conditions).

Usage:

$ ycli forms conditions submit list [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions submit get¶

Print one condition group (SURVEY_ID CONDITION_ID).

Usage:

$ ycli forms conditions submit get [OPTIONS] SURVEY_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions submit create¶

Create a condition group on the submit button (POST …/conditions).

Usage:

$ ycli forms conditions submit create [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --operator TEXT: Boolean operator: and | or.
• --item TEXT: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable).
• --body-file PATH: JSON file with the full {operator, items} group body.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions submit update¶

Replace condition group CONDITION_ID (PATCH — the API takes the FULL group, no partial).

Usage:

$ ycli forms conditions submit update [OPTIONS] SURVEY_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• --operator TEXT: Boolean operator: and | or.
• --item TEXT: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable).
• --body-file PATH: JSON file with the full {operator, items} group body.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions submit delete¶

Delete condition group CONDITION_ID (DELETE — the API answers 200, no body).

Usage:

$ ycli forms conditions submit delete [OPTIONS] SURVEY_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions submit set-operator¶

Set the operator BETWEEN the submit button's condition groups (collection PATCH).

Usage:

$ ycli forms conditions submit set-operator [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --operator TEXT: Boolean operator: and | or. [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions hook¶

Conditions that gate an integration group.

Usage:

$ ycli forms conditions hook [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the conditions of integration group...
• get: Print one condition group (SURVEY_ID...
• create: Create a condition group on the...
• update: Replace condition group CONDITION_ID...
• delete: Delete condition group CONDITION_ID...
• set-operator: Set the operator BETWEEN the integration...

ycli forms conditions hook list¶

List the conditions of integration group HOOK_ID (GET …/hooks/{id}/conditions).

Usage:

$ ycli forms conditions hook list [OPTIONS] SURVEY_ID HOOK_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions hook get¶

Print one condition group (SURVEY_ID HOOK_ID CONDITION_ID).

Usage:

$ ycli forms conditions hook get [OPTIONS] SURVEY_ID HOOK_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions hook create¶

Create a condition group on the integration group (POST …/conditions).

Usage:

$ ycli forms conditions hook create [OPTIONS] SURVEY_ID HOOK_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]

Options:

• --operator TEXT: Boolean operator: and | or.
• --item TEXT: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable).
• --body-file PATH: JSON file with the full {operator, items} group body.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions hook update¶

Replace condition group CONDITION_ID (PATCH — the API takes the FULL group, no partial).

Usage:

$ ycli forms conditions hook update [OPTIONS] SURVEY_ID HOOK_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• --operator TEXT: Boolean operator: and | or.
• --item TEXT: Condition clause as JSON: {"type", "condition", "question"?, "value"?} (repeatable).
• --body-file PATH: JSON file with the full {operator, items} group body.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions hook delete¶

Delete condition group CONDITION_ID (DELETE — the API answers 200, no body).

Usage:

$ ycli forms conditions hook delete [OPTIONS] SURVEY_ID HOOK_ID CONDITION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]
• CONDITION_ID: Condition group id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms conditions hook set-operator¶

Set the operator BETWEEN the integration group's condition groups (collection PATCH).

Usage:

$ ycli forms conditions hook set-operator [OPTIONS] SURVEY_ID HOOK_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]

Options:

• --operator TEXT: Boolean operator: and | or. [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms access¶

Forms survey permissions.

Usage:

$ ycli forms access [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print who may edit and who may fill form...
• set: Set the access level of one action on form...
• grant: Let a user (--uid / --cloud-uid) or a...
• revoke: Stop a user (--uid / --cloud-uid) or a...

ycli forms access get¶

Print who may edit and who may fill form SURVEY_ID (one entry per action).

Usage:

$ ycli forms access get [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms access set¶

Set the access level of one action on form SURVEY_ID (POST …/access).

Usage:

$ ycli forms access set [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --action TEXT: Action: change (edit, read answers) or submit (fill in). [required]
• --access TEXT: Level: owner, restricted, common or public. [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms access grant¶

Let a user (--uid / --cloud-uid) or a group (--group-src + --group-id) perform ACTION.

Usage:

$ ycli forms access grant [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --action TEXT: Action: change (edit, read answers) or submit (fill in). [required]
• --uid TEXT: User's Yandex ID uid.
• --cloud-uid TEXT: User's Yandex Cloud uid.
• --group-src TEXT: Group source: dir, cloud, com or staff.
• --group-id TEXT: Group id within its source.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms access revoke¶

Stop a user (--uid / --cloud-uid) or a group (--group-src + --group-id) performing ACTION.

Usage:

$ ycli forms access revoke [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --action TEXT: Action: change (edit, read answers) or submit (fill in). [required]
• --uid TEXT: User's Yandex ID uid.
• --cloud-uid TEXT: User's Yandex Cloud uid.
• --group-src TEXT: Group source: dir, cloud, com or staff.
• --group-id TEXT: Group id within its source.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms history¶

Forms change log.

Usage:

$ ycli forms history [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the changes made to form SURVEY_ID...

ycli forms history list¶

List the changes made to form SURVEY_ID (auto-paginated; --all for everything).

Usage:

$ ycli forms history list [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --ordering TEXT: desc (newest first, the API default) or asc.
• --limit INTEGER RANGE: Max items to fetch; 0 uses the default cap. [default: 0; x>=0]
• --all: Fetch everything, ignoring the cap.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms answers¶

Forms answers.

Usage:

$ ycli forms answers [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Fetch one answer (GET /answers).
• list: List a form's responses, filtered...
• export: Export a form's answers (POST...
• integrations-list: List the integration runs an answer...
• delete: Delete an answer (DELETE...
• restore: Bring a deleted answer back (POST...

ycli forms answers get¶

Fetch one answer (GET /answers). Pass exactly one of --answer-id / --answer-key.

The single-answer read is a flat query-param route, so no survey id is needed.

Usage:

$ ycli forms answers get [OPTIONS]

Options:

• --answer-id INTEGER: Numeric answer id (needs form-edit access; 0 = unset). [default: 0]
• --answer-key TEXT: Answer key hash (works without form-edit access).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms answers list¶

List a form's responses, filtered (auto-paginated; --all for everything).

Usage:

$ ycli forms answers list [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --limit INTEGER RANGE: Max items to fetch; 0 uses the default cap. [default: 0; x>=0]
• --all: Fetch everything, ignoring the cap.
• --questions TEXT: Comma-separated question ids to return answers for.
• --use-slugs: Name questions and options by slug, not id.
• --date-from TEXT: ISO-8601: answers given at or after.
• --date-to TEXT: ISO-8601: answers given at or before.
• --ordering TEXT: asc (oldest first) or desc (the default).
• --page-size INTEGER: Answers per request (the API's default is 25).
• --answer-format TEXT: default (cells by column) or raw (as stored).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms answers export¶

Export a form's answers (POST /answers/export) — async; --wait downloads the file.

Usage:

$ ycli forms answers export [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --format TEXT: Export format: csv or xlsx. [default: xlsx]
• --upload TEXT: Where to upload the result: default or disk (Yandex Disk). [default: default]
• --started-at TEXT: ISO-8601 start of the answer range (inclusive).
• --finished-at TEXT: ISO-8601 end of the answer range (inclusive).
• --limit INTEGER: Max answers to export (0 = all). [default: 0]
• --column TEXT: Column/question slug to include (repeatable).
• --pk INTEGER: Answer id to include (repeatable).
• --upload-files / --no-upload-files: Also export uploaded files to Disk.
• --wait / --no-wait: Poll to a terminal status, then download. [default: wait]
• --output TEXT: Write the exported file here; omit / '-' streams to stdout.
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms answers integrations-list¶

List the integration runs an answer triggered (exactly one of --answer-id / --answer-key).

Usage:

$ ycli forms answers integrations-list [OPTIONS]

Options:

• --answer-id INTEGER: Numeric answer id (needs form-edit access; 0 = unset). [default: 0]
• --answer-key TEXT: Answer key hash (works without form-edit access).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms answers delete¶

Delete an answer (DELETE /surveys/{id}/answers/{answer_id}); answers restore undoes it.

Usage:

$ ycli forms answers delete [OPTIONS] SURVEY_ID ANSWER_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• ANSWER_ID: Answer id (integer), from answers get. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms answers restore¶

Bring a deleted answer back (POST /surveys/{id}/answers/{answer_id}/restore).

Usage:

$ ycli forms answers restore [OPTIONS] SURVEY_ID ANSWER_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• ANSWER_ID: Answer id (integer), from answers get. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms keysets¶

Forms personal-link key sets.

Usage:

$ ycli forms keysets [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List key sets on form SURVEY_ID (GET...
• get: Print one key set (SURVEY_ID KEYSET_ID).
• create: Create a key set on form SURVEY_ID;...
• update: Replace key set KEYSET_ID on SURVEY_ID;...
• delete: Delete key set KEYSET_ID on SURVEY_ID...
• download: Download key set KEYSET_ID to --output (or...

ycli forms keysets list¶

List key sets on form SURVEY_ID (GET /surveys/{id}/keysets).

Usage:

$ ycli forms keysets list [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms keysets get¶

Print one key set (SURVEY_ID KEYSET_ID).

Usage:

$ ycli forms keysets get [OPTIONS] SURVEY_ID KEYSET_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• KEYSET_ID: Key set id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms keysets create¶

Create a key set on form SURVEY_ID; --enabled/--disabled is required.

POST /surveys/{id}/keysets: the API requires is_enabled, so it is always sent in the body.

Usage:

$ ycli forms keysets create [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --name TEXT: Key set name. [required]
• --total INTEGER: Number of keys to generate. [required]
• --enabled / --disabled: Create the set active (required — the API rejects a create without it). [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms keysets update¶

Replace key set KEYSET_ID on SURVEY_ID; every field is required.

PATCH: the API replaces the whole record, so name, total and enabled are sent together.

Usage:

$ ycli forms keysets update [OPTIONS] SURVEY_ID KEYSET_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• KEYSET_ID: Key set id (integer). [required]

Options:

• --name TEXT: Key set name (required — replaces the record). [required]
• --total INTEGER: Number of keys (required — replaces the record). [required]
• --enabled / --disabled: Active flag (required). [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms keysets delete¶

Delete key set KEYSET_ID on SURVEY_ID (DELETE /surveys/{id}/keysets/{keyset_id}).

Usage:

$ ycli forms keysets delete [OPTIONS] SURVEY_ID KEYSET_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• KEYSET_ID: Key set id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms keysets download¶

Download key set KEYSET_ID to --output (or stdout) as raw bytes.

Usage:

$ ycli forms keysets download [OPTIONS] SURVEY_ID KEYSET_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• KEYSET_ID: Key set id (integer). [required]

Options:

• --output TEXT: Write bytes to this path; omit / '-' streams to stdout.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms operations¶

Forms async operations.

Usage:

$ ycli forms operations [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print the status of async operation...

ycli forms operations get¶

Print the status of async operation OPERATION_ID (GET /operations/{id}).

Usage:

$ ycli forms operations get [OPTIONS] OPERATION_ID

Arguments:

• OPERATION_ID: Operation id from an async trigger (e.g. answers export). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms notifications¶

Forms integration runs (notifications).

Usage:

$ ycli forms notifications [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List integration runs, filtered...
• get: Print one run with its context, response...
• status-get: Print a run's state only (pending,...
• restart: Run the integration again for that answer...
• cancel: Stop a run that has not finished (POST...
• errors-list: List the ids of form SURVEY_ID's failed...

ycli forms notifications list¶

List integration runs, filtered (auto-paginated; --all for everything).

Usage:

$ ycli forms notifications list [OPTIONS]

Options:

• --survey-id TEXT: Only this form's runs (24-char hex id).
• --hook-id INTEGER: Only this integration group.
• --subscription-id INTEGER: Only this integration.
• --answer-id INTEGER: Only runs for this answer.
• --status TEXT: pending, success, error or canceled (repeatable).
• --created-since TEXT: ISO-8601: queued at or after.
• --created-until TEXT: ISO-8601: queued at or before.
• --finished-since TEXT: ISO-8601: ended at or after.
• --finished-until TEXT: ISO-8601: ended at or before.
• --visible / --no-visible: Only shown (or only hidden) runs.
• --type TEXT: email, tracker, tracker_comment, wiki, jsonrpc, http or function.
• --ordering TEXT: asc (oldest first, the default) or desc.
• --limit INTEGER RANGE: Max items to fetch; 0 uses the default cap. [default: 0; x>=0]
• --all: Fetch everything, ignoring the cap.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms notifications get¶

Print one run with its context, response and error.

Usage:

$ ycli forms notifications get [OPTIONS] NOTIFICATION_ID

Arguments:

• NOTIFICATION_ID: Notification id (integer), from notifications list. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms notifications status-get¶

Print a run's state only (pending, success, error or canceled).

Usage:

$ ycli forms notifications status-get [OPTIONS] NOTIFICATION_ID

Arguments:

• NOTIFICATION_ID: Notification id (integer), from notifications list. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms notifications restart¶

Run the integration again for that answer (POST /notifications/{id}/restart).

Usage:

$ ycli forms notifications restart [OPTIONS] NOTIFICATION_ID

Arguments:

• NOTIFICATION_ID: Notification id (integer), from notifications list. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms notifications cancel¶

Stop a run that has not finished (POST /notifications/{id}/cancel).

Usage:

$ ycli forms notifications cancel [OPTIONS] NOTIFICATION_ID

Arguments:

• NOTIFICATION_ID: Notification id (integer), from notifications list. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms notifications errors-list¶

List the ids of form SURVEY_ID's failed runs; read each with notifications get.

Usage:

$ ycli forms notifications errors-list [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms files¶

Forms form-filling file storage.

Usage:

$ ycli forms files [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• upload: Upload a file for form filling (POST...
• verify: Check upload status / access of...
• download: Download a stored file's raw bytes to...
• delete: Delete a stored file by --path and/or...

ycli forms files upload¶

Upload a file for form filling (POST …/files) — needs external storage on the form.

Usage:

$ ycli forms files upload [OPTIONS] SURVEY_ID FILE_PATH

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• FILE_PATH: Local file to upload. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms files verify¶

Check upload status / access of already-uploaded files (POST …/files/verify).

Usage:

$ ycli forms files verify [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --path TEXT: File path to check (repeatable).
• --url TEXT: File URL to check (repeatable, paired to --path).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms files download¶

Download a stored file's raw bytes to --output (or stdout). Binary is CLI/SDK-only.

Usage:

$ ycli forms files download [OPTIONS]

Options:

• --path TEXT: File download path (from an upload response). [required]
• -O, --output TEXT: Write to this path; omit or '-' for stdout.
• --download: Ask the API for a Content-Disposition filename header.
• --hash TEXT: Access hash from the upload response (anonymous download).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms files delete¶

Delete a stored file by --path and/or --url (DELETE /files).

Usage:

$ ycli forms files delete [OPTIONS]

Options:

• --path TEXT: File download path (from an upload response).
• --url TEXT: File download URL (from an upload response).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms images¶

Forms images.

Usage:

$ ycli forms images [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• upload: Upload an image to add to a form (POST...
• clone: Copy an existing image into the form (POST...

ycli forms images upload¶

Upload an image to add to a form (POST …/images); returns the image id and links.

Usage:

$ ycli forms images upload [OPTIONS] SURVEY_ID IMAGE_PATH

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• IMAGE_PATH: Local image file to upload. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms images clone¶

Copy an existing image into the form (POST …/images/clone); returns the new image.

Usage:

$ ycli forms images clone [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --image-id INTEGER: Id of the image to clone. [default: 0]
• --name TEXT: File name for the clone.
• --link TEXT: SIZE=URL of the image to clone (repeatable).
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms filling¶

Forms form filling.

Usage:

$ ycli forms filling [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get: Print the fillable-form settings for...
• submit: Submit a form response from --body-file...
• suggest: Get fill suggestions for a question (GET...

ycli forms filling get¶

Print the fillable-form settings for SURVEY (GET …/form) — pages, conditions, values.

Usage:

$ ycli forms filling get [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --key TEXT: Personal-link fill key, when the form uses one.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms filling submit¶

Submit a form response from --body-file (POST …/form); --validate-only validates only.

Usage:

$ ycli forms filling submit [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --body-file PATH: JSON file: an answer map keyed by question slug (see filling get values). [required]
• --validate-only: Validate only — save nothing, fire no integrations.
• --key TEXT: Personal-link fill key, when the form uses one.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms filling suggest¶

Get fill suggestions for a question (GET …/suggest).

Usage:

$ ycli forms filling suggest [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --question TEXT: Question slug the suggestion is for.
• --text TEXT: Text to search suggestions for.
• --id TEXT: Comma-separated suggestion-object ids to resolve.
• --parent-id TEXT: Parent ids for a Master/Detail lookup.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms hooks¶

Forms integration groups (hooks).

Usage:

$ ycli forms hooks [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the integration groups of form...
• get: Print one integration group (SURVEY_ID...
• create: Create an integration group on form...
• update: Change integration group HOOK_ID: only the...
• delete: Delete integration group HOOK_ID with all...

ycli forms hooks list¶

List the integration groups of form SURVEY_ID with their integrations.

Usage:

$ ycli forms hooks list [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms hooks get¶

Print one integration group (SURVEY_ID HOOK_ID).

Usage:

$ ycli forms hooks get [OPTIONS] SURVEY_ID HOOK_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms hooks create¶

Create an integration group on form SURVEY_ID (POST /surveys/{id}/hooks).

Usage:

$ ycli forms hooks create [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• --name TEXT: Integration group name (max 100 characters).
• --active / --inactive: Run the group's integrations, or pause them.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms hooks update¶

Change integration group HOOK_ID: only the options given change (PATCH).

Usage:

$ ycli forms hooks update [OPTIONS] SURVEY_ID HOOK_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]

Options:

• --name TEXT: Integration group name (max 100 characters).
• --active / --inactive: Run the group's integrations, or pause them.
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms hooks delete¶

Delete integration group HOOK_ID with all its integrations and conditions.

Usage:

$ ycli forms hooks delete [OPTIONS] SURVEY_ID HOOK_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms subscriptions¶

Forms integrations of an integration group.

Usage:

$ ycli forms subscriptions [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the integrations of hook HOOK_ID (GET...
• get: Print one integration (SURVEY_ID HOOK_ID...
• create: Add an integration to hook HOOK_ID from a...
• update: Change integration SUBSCRIPTION_ID: only...
• delete: Delete integration SUBSCRIPTION_ID from...
• attach: Upload a file for the integration's fixed...

ycli forms subscriptions list¶

List the integrations of hook HOOK_ID (GET …/hooks/{id}/subscriptions).

Usage:

$ ycli forms subscriptions list [OPTIONS] SURVEY_ID HOOK_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms subscriptions get¶

Print one integration (SURVEY_ID HOOK_ID SUBSCRIPTION_ID).

Usage:

$ ycli forms subscriptions get [OPTIONS] SURVEY_ID HOOK_ID SUBSCRIPTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]
• SUBSCRIPTION_ID: Integration id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms subscriptions create¶

Add an integration to hook HOOK_ID from a JSON body (POST …/subscriptions).

Usage:

$ ycli forms subscriptions create [OPTIONS] SURVEY_ID HOOK_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]

Options:

• --body-file PATH: JSON file with the integration body; "type" selects it: email, tracker, tracker_comment, wiki, jsonrpc, http or function. [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms subscriptions update¶

Change integration SUBSCRIPTION_ID: only the fields in the JSON body change (PATCH).

Usage:

$ ycli forms subscriptions update [OPTIONS] SURVEY_ID HOOK_ID SUBSCRIPTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]
• SUBSCRIPTION_ID: Integration id (integer). [required]

Options:

• --body-file PATH: JSON file with the integration body; "type" selects it: email, tracker, tracker_comment, wiki, jsonrpc, http or function. [required]
• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms subscriptions delete¶

Delete integration SUBSCRIPTION_ID from hook HOOK_ID.

Usage:

$ ycli forms subscriptions delete [OPTIONS] SURVEY_ID HOOK_ID SUBSCRIPTION_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]
• SUBSCRIPTION_ID: Integration id (integer). [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms subscriptions attach¶

Upload a file for the integration's fixed attachments; returns its path.

Usage:

$ ycli forms subscriptions attach [OPTIONS] SURVEY_ID HOOK_ID SUBSCRIPTION_ID FILE_PATH

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]
• HOOK_ID: Integration group (hook) id (integer). [required]
• SUBSCRIPTION_ID: Integration id (integer). [required]
• FILE_PATH: Local file to attach to every run. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.

ycli forms variables¶

Variables available to a form's integrations.

Usage:

$ ycli forms variables [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• list: List the variable types integrations of...

ycli forms variables list¶

List the variable types integrations of form SURVEY_ID can reference.

Usage:

$ ycli forms variables list [OPTIONS] SURVEY_ID

Arguments:

• SURVEY_ID: Form id, e.g. 6818ceffe010db4f59d11329. [required]

Options:

• -o, --format [auto|json|yaml|pretty]: Output format (auto = pretty on a TTY, JSON when piped).
• --jq EXPR: Filter the JSON result through a jq expression; strings print raw, like jq -r. Needs the jq extra.
• -y, --yes: Do not ask before an operation that deletes data.
• --dry-run: Do not send a write: print the request it would send instead. Reads still run, and only the first write of a command is shown.
• --help: Show this message and exit.