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

# Create Contact Edition

> `If-Match` carries the `edition` of the slice the range starts in, as read. A satellite not yet written is created by a PUT with `If-None-Match: *` instead, on a range that runs to `9999-12-31`. The response's `ETag` is the edition written.



## OpenAPI

````yaml /api-reference/preview.json put /gb/organizations/{organization_id}/contact
openapi: 3.2.0
info:
  description: Intermezzo's global payroll apis, organized by country
  summary: Global Payroll Platform
  title: Intermezzo Global Payroll
  version: '2026-11-18'
  x-logo:
    url: /static/icon.svg
servers:
  - description: Preview
    url: https://preview.intermezzo.ai
security: []
paths:
  /gb/organizations/{organization_id}/contact:
    put:
      tags:
        - Great Britain
        - Organizations
        - Contact
      summary: Create Contact Edition
      description: >-
        `If-Match` carries the `edition` of the slice the range starts in, as
        read. A satellite not yet written is created by a PUT with
        `If-None-Match: *` instead, on a range that runs to `9999-12-31`. The
        response's `ETag` is the edition written.
      operationId: gb_organization_contact_put
      parameters:
        - in: path
          name: organization_id
          required: true
          schema:
            title: Organization Id
            type: string
        - in: header
          name: If-Match
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: If-Match
        - in: header
          name: If-None-Match
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: If-None-Match
        - description: >-
            The person acting through the access credential, recorded as
            `created_by` of what the request writes. Audit only: access is
            checked on the credential.
          in: header
          name: X-Acting-User
          required: false
          schema:
            anyOf:
              - maxLength: 255
                minLength: 1
                type: string
              - type: 'null'
            description: >-
              The person acting through the access credential, recorded as
              `created_by` of what the request writes. Audit only: access is
              checked on the credential.
            title: X-Acting-User
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GBOrganizationContactWrite'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GBOrganizationContactSatellite'
          description: Successful Response
        '404':
          content:
            application/json:
              examples:
                HUB_NOT_FOUND:
                  summary: >-
                    Raised when a hub does not exist under the parent named in
                    the path.
                  value:
                    errors:
                      - code: HUB_NOT_FOUND
                        message: >-
                          Raised when a hub does not exist under the parent
                          named in the path.
                SATELLITE_NOT_FOUND:
                  summary: >-
                    Raised on a read of a satellite that was never written:
                    neither sent when its hub was created nor written by a PUT
                    since.
                  value:
                    errors:
                      - code: SATELLITE_NOT_FOUND
                        message: >-
                          Raised on a read of a satellite that was never
                          written: neither sent when its hub was created nor
                          written by a PUT since.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - HUB_NOT_FOUND
                            - SATELLITE_NOT_FOUND
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `HUB_NOT_FOUND`: Raised when a hub does not exist under the parent
            named in the path.

            - `SATELLITE_NOT_FOUND`: Raised on a read of a satellite that was
            never written: neither sent when its hub was created nor written by
            a PUT since.
        '409':
          content:
            application/json:
              examples:
                HUB_CLOSED:
                  summary: >-
                    Raised on a write to a closed hub: it stays readable, its
                    satellites take no writes.
                  value:
                    errors:
                      - code: HUB_CLOSED
                        message: >-
                          Raised on a write to a closed hub: it stays readable,
                          its satellites take no writes.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - HUB_CLOSED
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `HUB_CLOSED`: Raised on a write to a closed hub: it stays
            readable, its satellites take no writes.
        '412':
          content:
            application/json:
              examples:
                EDITION_MISMATCH:
                  summary: >-
                    Raised when If-Match names an edition other than the one the
                    range lies in.
                  value:
                    errors:
                      - code: EDITION_MISMATCH
                        message: >-
                          Raised when If-Match names an edition other than the
                          one the range lies in.
                SATELLITE_EXISTS:
                  summary: >-
                    Raised on a write under `If-None-Match: *`, which creates
                    the satellite, when the satellite already has editions.
                  value:
                    errors:
                      - code: SATELLITE_EXISTS
                        message: >-
                          Raised on a write under `If-None-Match: *`, which
                          creates the satellite, when the satellite already has
                          editions.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - EDITION_MISMATCH
                            - SATELLITE_EXISTS
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `EDITION_MISMATCH`: Raised when If-Match names an edition other
            than the one the range lies in.

            - `SATELLITE_EXISTS`: Raised on a write under `If-None-Match: *`,
            which creates the satellite, when the satellite already has
            editions.
        '422':
          content:
            application/json:
              examples:
                PRECONDITION_MALFORMED:
                  summary: Raised when If-Match is not one quoted version number.
                  value:
                    errors:
                      - code: PRECONDITION_MALFORMED
                        message: Raised when If-Match is not one quoted version number.
                RANGE_CROSSES_EDITION:
                  summary: >-
                    Raised when a write's range runs past the end of the edition
                    it starts in.
                  value:
                    errors:
                      - code: RANGE_CROSSES_EDITION
                        message: >-
                          Raised when a write's range runs past the end of the
                          edition it starts in.
                VALUE_OUT_OF_RANGE:
                  summary: Raised when a date lies outside the satellite's coverage.
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        message: >-
                          Raised when a date lies outside the satellite's
                          coverage.
                VALUE_OUT_OF_RANGE (FirstEditionNotOpenEndedError):
                  summary: >-
                    Raised when the write that creates a satellite ends before
                    9999-12-31: no later write changes coverage, so a shorter
                    first range would stay short for good.
                  value:
                    errors:
                      - code: VALUE_OUT_OF_RANGE
                        message: >-
                          Raised when the write that creates a satellite ends
                          before 9999-12-31: no later write changes coverage, so
                          a shorter first range would stay short for good.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - PRECONDITION_MALFORMED
                            - RANGE_CROSSES_EDITION
                            - VALUE_OUT_OF_RANGE
                            - FIELD_REQUIRED
                            - FIELD_INVALID_TYPE_STRING
                            - FIELD_INVALID_TYPE_INT
                            - FIELD_INVALID_TYPE_FLOAT
                            - FIELD_INVALID_TYPE_BOOL
                            - FIELD_INVALID_TYPE_DICT
                            - FIELD_INVALID_TYPE_LIST
                            - FIELD_STRING_TOO_SHORT
                            - FIELD_STRING_TOO_LONG
                            - FIELD_STRING_PATTERN_MISMATCH
                            - FIELD_VALUE_TOO_SMALL
                            - FIELD_VALUE_TOO_LARGE
                            - FIELD_INVALID_DATE
                            - FIELD_INVALID_DATETIME
                            - FIELD_INVALID_TIME
                            - FIELD_INVALID_DATE_FORMAT
                            - FIELD_INVALID_DATETIME_FORMAT
                            - FIELD_INVALID_ENUM_VALUE
                            - FIELD_INVALID_EMAIL
                            - FIELD_INVALID_URL
                            - FIELD_LIST_TOO_SHORT
                            - FIELD_LIST_TOO_LONG
                            - FIELD_UNKNOWN
                            - FIELD_VALIDATION_ERROR
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            The request failed validation. Type and format errors use the
            generic FIELD_* codes.

            - `PRECONDITION_MALFORMED`: Raised when If-Match is not one quoted
            version number.

            - `RANGE_CROSSES_EDITION`: Raised when a write's range runs past the
            end of the edition it starts in.

            - `VALUE_OUT_OF_RANGE`: Raised when a date lies outside the
            satellite's coverage.

            - `VALUE_OUT_OF_RANGE`: Raised when the write that creates a
            satellite ends before 9999-12-31: no later write changes coverage,
            so a shorter first range would stay short for good.
        '428':
          content:
            application/json:
              examples:
                PRECONDITION_REQUIRED:
                  summary: Raised when a write that needs If-Match arrives without it.
                  value:
                    errors:
                      - code: PRECONDITION_REQUIRED
                        message: >-
                          Raised when a write that needs If-Match arrives
                          without it.
              schema:
                properties:
                  errors:
                    items:
                      additionalProperties: false
                      description: >-
                        Represents an error that occurred during processing.


                        Designed for client-side i18n:

                        - code: Use this to look up translation (e.g.,
                        "HUB_NOT_FOUND")

                        - message: English fallback if translation not available

                        - field: Field name for form validation highlighting

                        - params: Dynamic values for translation interpolation
                      properties:
                        code:
                          description: Unique error code for i18n lookup
                          enum:
                            - PRECONDITION_REQUIRED
                          title: Code
                          type: string
                        field:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: Field that caused the error
                          title: Field
                        message:
                          description: English fallback error message
                          title: Message
                          type: string
                        params:
                          anyOf:
                            - additionalProperties: true
                              type: object
                            - type: 'null'
                          description: Parameters for translation interpolation
                          title: Params
                      required:
                        - code
                        - message
                      title: ErrorDetail
                      type: object
                    type: array
                required:
                  - errors
                title: ErrorResponse
                type: object
          description: >-
            - `PRECONDITION_REQUIRED`: Raised when a write that needs If-Match
            arrives without it.
      security:
        - BearerToken: []
components:
  schemas:
    GBOrganizationContactWrite:
      additionalProperties: false
      properties:
        contacts:
          description: Contacts; empty when none
          items:
            $ref: '#/components/schemas/GBOrganizationContactEntry'
          title: Contacts
          type: array
        hmrc_sender_email:
          anyOf:
            - format: email
              type: string
            - type: 'null'
          description: >-
            Where HMRC writes to the sender about the employer's filings; null
            when none
          examples:
            - payroll@acme.example
          title: Hmrc Sender Email
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - contacts
        - hmrc_sender_email
        - valid_from
        - valid_to
      title: GBOrganizationContactWrite
      type: object
    GBOrganizationContactSatellite:
      additionalProperties: false
      properties:
        contacts:
          items:
            $ref: '#/components/schemas/GBOrganizationContactEntryRead'
          title: Contacts
          type: array
        created_at:
          format: date-time
          readOnly: true
          title: Created At
          type: string
        created_by:
          description: >-
            Who wrote the edition: the acting user (`X-Acting-User`, else the
            access credential), `system` for our own writes, or
            `<authority>:<notice>` for a write on an authority's behalf, e.g.
            `hmrc:P6`.
          readOnly: true
          title: Created By
          type: string
        edition:
          readOnly: true
          title: Edition
          type: integer
        hmrc_sender_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Hmrc Sender Email
        valid_from:
          format: date
          title: Valid From
          type: string
        valid_to:
          format: date
          title: Valid To
          type: string
      required:
        - edition
        - valid_from
        - valid_to
        - created_at
        - created_by
      title: GBOrganizationContactSatellite
      type: object
    GBOrganizationContactEntry:
      additionalProperties: false
      properties:
        email:
          anyOf:
            - format: email
              type: string
            - type: 'null'
          examples:
            - payroll@acme.example
          title: Email
        is_primary:
          description: The first contact authorities are given
          title: Is Primary
          type: boolean
        name:
          examples:
            - Jane Smith
          minLength: 1
          title: Name
          type: string
        phone:
          anyOf:
            - $ref: '#/components/schemas/ContactPhoneNumber'
            - type: 'null'
        roles:
          description: What the contact is for; empty when unspecified
          items:
            type: string
          title: Roles
          type: array
      required:
        - name
        - email
        - phone
        - roles
        - is_primary
      title: GBOrganizationContactEntry
      type: object
    GBOrganizationContactEntryRead:
      additionalProperties: false
      properties:
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        is_primary:
          default: false
          title: Is Primary
          type: boolean
        name:
          examples:
            - Jane Smith
          minLength: 1
          title: Name
          type: string
        phone:
          anyOf:
            - $ref: '#/components/schemas/ContactPhoneNumber'
            - type: 'null'
        roles:
          items:
            type: string
          title: Roles
          type: array
      required:
        - name
      title: GBOrganizationContactEntryRead
      type: object
    ContactPhoneNumber:
      additionalProperties: false
      properties:
        phone_number:
          format: phone
          title: Phone Number
          type: string
        phone_type:
          $ref: '#/components/schemas/PhoneType'
      required:
        - phone_number
        - phone_type
      title: ContactPhoneNumber
      type: object
    PhoneType:
      enum:
        - MOBILE
        - HOME
        - WORK
      title: PhoneType
      type: string
  securitySchemes:
    BearerToken:
      bearerFormat: JWT
      description: Get token from Auth0 and paste it here
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.