Skip to main content

OrganizationAssignmentResult

The outcome of assigning one organization to a brokerage firm

type OrganizationAssignmentResult {
  organizationUlid: ID!
  reason: String
  status: OrganizationAssignmentStatus!
}

Fields​

OrganizationAssignmentResult.organizationUlid ● ID! non-null scalar​

The submitted identifier, echoed verbatim — including when it resolved to nothing, and including a value that is not a well-formed ULID. Use it to correlate a result back to what you sent.

OrganizationAssignmentResult.reason ● String scalar​

Populated only when status is FAILED, and null otherwise. A machine-readable constant, never a sentence about a resource you cannot otherwise see. One of:

ORGANIZATION_ULID_MALFORMED — the value you sent is not a well-formed ULID. Decided before any lookup, so it describes only your input.

ORGANIZATION_NOT_FOUND_OR_NOT_PERMITTED — the organization does not exist, belongs to another partner, or is otherwise not one you control. These are deliberately indistinguishable: the single fact behind this value is that the identifier was absent from the set of organizations you control.

OrganizationAssignmentResult.status ● OrganizationAssignmentStatus! non-null enum​

What happened to this organization

Member Of​

AssignOrganizationsToFirmResult object ● CreateBrokerageFirmResult object