Skip to main content

CreateOrganizationInput

An input type used when creating an Organization

input CreateOrganizationInput {
address: PhysicalAddressInput
bank: BankPartner
brand: String
ein: String
externalId: String
name: String!
organizationGroupId: ID
}

Fields

CreateOrganizationInput.address ● PhysicalAddressInput input

The physical address of the Organization

CreateOrganizationInput.bank ● BankPartner enum

Bank/custodian for shard placement. Supply with brand to place on that exact (partner, bank, brand) shard, or alone to place on the partner's shard for that bank — which requires the bank to hold exactly one brand for the partner. Omitted == placement is resolved from brand alone, or left to the default.

CreateOrganizationInput.brand ● String scalar

Brand name for shard placement. Supply with bank to place on that exact (partner, bank, brand) shard, or alone to place on the partner's shard for that brand across whichever bank holds it. Omitted == placement is resolved from bank alone, or left to the default.

CreateOrganizationInput.ein ● String scalar

The Employer Identification Number (EIN) of the Organization

CreateOrganizationInput.externalId ● String scalar

A partner-scoped external identifier for the Organization. Must be unique within the partner.

CreateOrganizationInput.name ● String! non-null scalar

The user-displayable name of the Organization

CreateOrganizationInput.organizationGroupId ● ID scalar

The ID of the Organization Group this Organization belongs to

Member Of

createOrganization mutation