Skip to main content

CreateOrganizationGroupInput

An input type used when creating an Organization Group

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

Fields​

CreateOrganizationGroupInput.address ● PhysicalAddressInput input​

The physical address of the Organization Group

CreateOrganizationGroupInput.bank ● ID scalar​

Optionally identifies the bank this organization group is placed on, by the ID First Dollar gave you or one returned in a shard-resolution error's extensions.custodians. 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 bank that your API credentials belong to. If that bank carries more than one of the partner's brands, the mutation fails with a top-level AMBIGUOUS_SHARD error; pass brand to choose one. An ID that is not a bank is rejected with BAD_USER_INPUT, with the accepted IDs in extensions.custodians.

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