CreateOrganizationGroupInput

An input type used when creating an Organization Group

input CreateOrganizationGroupInput {
  address: PhysicalAddressInput
  bank: BankPartner
  brand: String
  ein: String
  externalId: String
  name: String!
  phone: PhoneNumber
}

Fields

CreateOrganizationGroupInput.address ● PhysicalAddressInput input

The physical address of the Organization Group

CreateOrganizationGroupInput.bank ● BankPartner enum

Optionally identifies the bank (custodian) this organization group is placed on. Supplied together with brand, it selects the (partner, bank, brand) shard; supplied on its own, the bank's shard, which requires that bank to carry exactly one brand. Omit both to place the organization group on the shard the caller is scoped to.

CreateOrganizationGroupInput.brand ● String scalar

Optionally identifies the brand this organization group belongs to. Only needed to disambiguate when the partner has more than one brand; single-brand callers may omit it. Supplied without a bank, it resolves across every bank the partner holds, so it must identify exactly one shard.

CreateOrganizationGroupInput.ein ● String scalar

The Employer Identification Number (EIN) of the Organization Group

CreateOrganizationGroupInput.externalId ● String scalar

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

CreateOrganizationGroupInput.name ● String! non-null scalar

The user-displayable name of the Organization Group

CreateOrganizationGroupInput.phone ● PhoneNumber scalar

The US phone number of the Organization Group (10 digits, no punctuation)

Member Of

createOrganizationGroup mutation