Describe selected profile or kit write contracts

Supply 1–20 exact answerKeys from search in the same target context. Returns type-specific write formats, illustrative PATCH body examples, containing group paths and read/write tool arguments. Resolve options/users and replace existing-row ID placeholders before writing. A description is not authorization or a dry run.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Comma-separated persisted repeating-row IDs, outermost first; options only. Never answer values or invented IDs.

string
enum
required

Explicit target scope. Never defaults to a superset.

Allowed:
string

Target company public/entity ID; required only for connection_profile.

string
enum

Calling entity's role. Defaults to buyer for connection lookups.

Allowed:
string

Required for kit scope. Shared type contracts do not imply access to every kit instance.

string

Existing kit ID or an unambiguous connection alias. Omit for type-only discovery; new explicitly describes creation.

string

Metadata locale; defaults to the authenticated user's locale.

string

Search question keys, localized constant labels, topic/group paths and tags; on options, search option values/labels.

string

Comma-separated exact answer keys, at most 20. Required for describe; exactly one for options.

string

Comma-separated question IDs from search; use to disambiguate duplicated keys.

string

Exact topic key.

string

Exact containing group key.

string

Exact question type, for example file, contact, userselect or group.

string

Comma-separated tags; match any of these tags, at most 20.

number
1 to 50

Page size: search/options default 10, describe default 20. Response byte budgets also apply.

string

Continuation cursor from this query/context. Restart discovery if metadata or access changed.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json