Skip to main content

SubmitAppBlockFormInput

A form drawn in an app block on an admin record, submitted by a person. The server holds the form's definition; the client sends only which form and the values.

input SubmitAppBlockFormInput {
contextId: ID!
extensionHandle: String!
formKey: String!
idempotencyKey: String!
installationId: ID!
target: String!
values: [AppBlockFormValueInput!]!
}

Fields​

SubmitAppBlockFormInput.contextId ● ID! non-null scalar​

The record the block is open on.

SubmitAppBlockFormInput.extensionHandle ● String! non-null scalar​

The handle of the app's extension that drew the block.

SubmitAppBlockFormInput.formKey ● String! non-null scalar​

The form's key in the layout.

SubmitAppBlockFormInput.idempotencyKey ● String! non-null scalar​

A key the client makes once per submit. The same key again returns the first result and writes nothing.

SubmitAppBlockFormInput.installationId ● ID! non-null scalar​

The app installation the block is from.

SubmitAppBlockFormInput.target ● String! non-null scalar​

The admin slot the block is drawn in, e.g. admin.order.details.block.

SubmitAppBlockFormInput.values ● [AppBlockFormValueInput!]! non-null input​

The values, one per form field. A form with no inputs sends none.

Member Of​

submitAppBlockForm mutation