Organizations > Organizations > organizationsModify
Commerce APIOrganizationsOrganizationsorganizationsModify

organizationsModify

POST:organizations.json

Description

Modify an existing organization.

Even though API takes array as body, modifying only one organization at a time is allowed. API looks like that for consistency reasons.

Topic: Organizations

Arguments

data: [OrganizationModify!]!

Main argument for mutations.


organization_id: String

Unique organization identifier. See also: Unique Identifiers

Example: "og_EQzGqWoY"


Data Argument Fields

billing_address: AddressCreate

Billing address of the organization


custom_invoice_text: String

Additional text to add to an organization billing invoice

Valid when: custom_invoice_text's length doesn't exceed 4096 characters


default_payment_method_id: String

Unique payment method identifier. See also: Unique Identifiers

Example: "pm_EQzGqWoY"

Valid when: default_payment_method_id matches regexp pattern: ^pm_


name: String

The name of the organization

Example: "FooBar Inc."

Valid when: name is not empty

Valid when: name's length doesn't exceed 250 characters


Result

[Organization!]

Preview (typescript)

Loading module