> ## Documentation Index
> Fetch the complete documentation index at: https://getprescience.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a group

> Updates writable group fields (same fields as create).



## OpenAPI

````yaml /api-reference/openapi.json patch /groups/{groupId}
openapi: 3.1.0
info:
  title: Prescience Partner API
  version: 1.1.0
  description: >-
    Create employer groups, submit census records, generate indicative quotes,
    create enrollments, and read aggregate account data.


    Money is always integer cents. Dates are `YYYY-MM-DD`; timestamps are ISO
    8601 UTC. Quotes are indicative pending underwriting confirmation. A BAA and
    data processing agreement are executed before live mode is enabled.
  contact:
    name: Prescience partner engineering
    email: partners@getprescience.com
servers:
  - url: https://www.getprescience.com/api/partner/v1
    description: >-
      Production. Test and live traffic share this host; mode comes from your
      API key.
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Connectivity and key checks.
  - name: Plans
    description: Static plan metadata.
  - name: Groups
    description: 'Employer groups: the root resource of every integration.'
  - name: Census
    description: Pre-enrollment census intake and ongoing member sync.
  - name: Quotes
    description: Deterministic, synchronous quotes. Indicative pending underwriting.
  - name: Enrollments
    description: Plan selection and employer provisioning.
  - name: Account
    description: Aggregate, de-identified employer account data.
  - name: Webhooks
    description: Signed event delivery (standard-webhooks scheme).
paths:
  /groups/{groupId}:
    patch:
      tags:
        - Groups
      summary: Update a group
      description: Updates writable group fields (same fields as create).
      operationId: updateGroup
      parameters:
        - $ref: '#/components/parameters/GroupId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupCreateRequest'
            example:
              contact:
                name: Dana Park
                email: dana@acme.com
                title: VP People
      responses:
        '200':
          description: Updated group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              example:
                id: grp_8c2f41d09a3e
                mode: test
                status: created
                companyName: Acme Inc
                domain: acme.com
                externalId: co_4821
                address:
                  line1: 548 Market St
                  city: San Francisco
                  state: CA
                  zip: '94104'
                contact:
                  name: Dana Park
                  email: dana@acme.com
                  title: VP People
                currentCoverage:
                  planType: fully_insured
                  carrier: Anthem
                  pepmCents: 80000
                  renewalDate: '2026-09-01'
                censusMemberCount: 0
                companyState: null
                createdAt: '2026-06-10T17:04:11Z'
                updatedAt: '2026-06-11T08:30:12Z'
        '400':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_request
                message: domain must be a valid domain.
                details:
                  - field: domain
                    message: domain must be a valid domain
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    GroupId:
      name: groupId
      in: path
      required: true
      description: Group ID, e.g. `grp_8c2f41d09a3e`.
      schema:
        type: string
        pattern: ^grp_[0-9a-f]{12}$
      example: grp_8c2f41d09a3e
  schemas:
    GroupCreateRequest:
      type: object
      required:
        - companyName
        - domain
      properties:
        externalId:
          type: string
          description: >-
            Your internal employer ID. Echoed back on the group and useful for
            reconciliation.
          example: co_4821
        companyName:
          type: string
          example: Acme Inc
        legalEntityName:
          type: string
          example: Acme Incorporated
        domain:
          type: string
          description: Primary company domain. One enrolled group per domain per mode.
          example: acme.com
        ein:
          type: string
          example: 94-2404110
        address:
          $ref: '#/components/schemas/Address'
        contact:
          $ref: '#/components/schemas/Contact'
        currentCoverage:
          $ref: '#/components/schemas/CurrentCoverage'
    Group:
      type: object
      required:
        - id
        - mode
        - status
        - companyName
        - domain
        - censusMemberCount
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          example: grp_8c2f41d09a3e
        mode:
          type: string
          enum:
            - test
            - live
        status:
          type: string
          enum:
            - created
            - census_received
            - quoted
            - enrolled
            - active
          description: >-
            Lifecycle: `created` -> `census_received` -> `quoted` -> `enrolled`
            -> `active` (active = company flipped to prod by Prescience).
        companyName:
          type: string
          example: Acme Inc
        domain:
          type: string
          example: acme.com
        externalId:
          type:
            - string
            - 'null'
          description: Your internal employer ID.
          example: co_4821
        address:
          $ref: '#/components/schemas/Address'
        contact:
          $ref: '#/components/schemas/Contact'
        currentCoverage:
          $ref: '#/components/schemas/CurrentCoverage'
        censusMemberCount:
          type: integer
          example: 12
        companyState:
          type:
            - string
            - 'null'
          enum:
            - sandbox
            - prod
            - null
          description: >-
            `null` until enrolled, then `sandbox`, then `prod` once Prescience
            activates the group.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          enum:
            - unauthorized
            - live_mode_disabled
            - forbidden
            - not_found
            - invalid_request
            - conflict
            - quote_expired
            - census_required
            - rate_limited
            - server_error
            - not_configured
          description: Stable machine-readable error code.
        message:
          type: string
          description: >-
            Human-readable explanation. Wording may change; branch on `error`,
            not `message`.
        details:
          type: array
          description: Present on `invalid_request`. One entry per failed field.
          items:
            type: object
            required:
              - field
              - message
            properties:
              field:
                type: string
                example: zip
              message:
                type: string
                example: zip must be a 5-digit ZIP code
              index:
                type: integer
                description: >-
                  For array payloads (census rows), the zero-based index of the
                  failing row.
                example: 7
    Address:
      type: object
      properties:
        line1:
          type: string
          example: 548 Market St
        city:
          type: string
          example: San Francisco
        state:
          type: string
          example: CA
        zip:
          type: string
          example: '94104'
    Contact:
      type: object
      properties:
        name:
          type: string
          example: Dana Park
        email:
          type: string
          format: email
          example: dana@acme.com
        title:
          type: string
          example: Head of People
    CurrentCoverage:
      type: object
      description: >-
        The employer's coverage today. `pepmCents` is used as the savings
        baseline when quoting unless overridden per-quote.
      properties:
        planType:
          type: string
          enum:
            - fully_insured
            - peo
            - ichra
            - level_funded
            - none
          example: fully_insured
        carrier:
          type: string
          example: Anthem
        pepmCents:
          type: integer
          description: Current all-in cost per employee per month, in cents.
          example: 80000
        renewalDate:
          type: string
          format: date
          example: '2026-09-01'
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: >-
              Provide a valid partner API key as `Authorization: Bearer
              psk_...`.
    NotFound:
      description: >-
        No such resource in this mode. Test keys only see test resources; live
        keys only see live resources.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: not_found
            message: No group grp_8c2f41d09a3e found.
    RateLimited:
      description: Rate limit exceeded. Honor `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: rate_limited
            message: Rate limit exceeded. Retry after 12 seconds.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
          example: 12
    ServerError:
      description: >-
        Something failed on our side. Safe to retry with the same
        `Idempotency-Key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: server_error
            message: Internal error. The request was not applied.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Partner API key. `psk_test_<32 hex>` for test mode, `psk_live_<32 hex>`
        for live mode. Keys are stored hashed and cannot be recovered; store
        them in your secrets manager on issue.

````