openapi: 3.2.0
info:
  title: Popp Users API
  description: Popp API documentation
  version: '1'
servers:
- url: https://api.joinpopp.com
  description: Development server
security:
- popp_api_key: []
  organization_id: []
tags:
- name: Users
paths:
  /v1/organizations/{id}/users:
    get:
      summary: List Organization Users
      description: List the users in a specific organization (paginated), each with their per-organization access. Scoped to the organization group behind your API key; an organization in another group returns 404. Authenticated with your API key alone.
      operationId: list-organization-users
      parameters:
      - name: id
        in: path
        description: The organization id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      - name: limit
        in: query
        description: Maximum number of items per page (1-50). Defaults to 20.
        required: false
        schema:
          $ref: '#/components/schemas/limit-27c292e0-baed-45b9-91e6-4dbd3491ffdd'
      - name: nextToken
        in: query
        description: Pagination token returned by a previous call.
        required: false
        schema:
          $ref: '#/components/schemas/nextToken'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users:
    get:
      summary: List Users
      description: List the users in the organization group behind your API key (paginated), each with their per-organization access.
      operationId: list-users
      parameters:
      - name: limit
        in: query
        description: Maximum number of items per page (1-50). Defaults to 20.
        required: false
        schema:
          $ref: '#/components/schemas/auth_service_limit'
      - name: nextToken
        in: query
        description: Pagination token returned by a previous call.
        required: false
        schema:
          $ref: '#/components/schemas/nextToken'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
    post:
      summary: Create User
      description: Create or invite a user with access to one or more organizations in the organization group behind your API key. Name each organization either by its Popp organizationId or by your own externalOrganizationId (exactly one per entry). Returns 409 if a user with the email already exists. Set sendInvite=false to provision silently (SSO) with no invitation email.
      operationId: create-user
      parameters: []
      tags:
      - Users
      security:
      - popp_api_key: []
      requestBody:
        description: The user to create and their organization access.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users/by-email/{email}:
    get:
      summary: Get User by Email
      description: Get a single user, with their per-organization access, by email address.
      operationId: get-user-by-email
      parameters:
      - name: email
        in: path
        description: The URL-encoded email address of the user.
        required: true
        schema:
          $ref: '#/components/schemas/auth_service_email'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
    patch:
      summary: Update User by Email
      description: Update a user's name, organization access and/or group-level role, identified by email. The organizations array uses replace-semantics (send the full desired set), while a field you omit is left unchanged; name each organization either by its Popp organizationId or by your own externalOrganizationId (exactly one per entry).
      operationId: update-user-by-email
      parameters:
      - name: email
        in: path
        description: The user's email address.
        required: true
        schema:
          $ref: '#/components/schemas/email-36a90113-55ff-4550-a801-6fdb688e2ce8'
      tags:
      - Users
      security:
      - popp_api_key: []
      requestBody:
        description: The updated name, organization access and/or group role.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
    delete:
      summary: Delete User by Email
      description: 'Permanently delete a user, identified by email. **This cannot be undone.** Their sign-in is removed, all organization access is revoked and their personal details are erased. Records they created, such as campaigns and conversations, are kept and still show them as the author. Their email address becomes free to invite again. Returns 409 if the user still has an enabled API key: revoke it first, or every call made with that key will stop working. To remove access reversibly, use Deactivate User instead.'
      operationId: delete-user-by-email
      parameters:
      - name: email
        in: path
        description: The user's email address.
        required: true
        schema:
          $ref: '#/components/schemas/email-bb440892-608c-4cfb-a29a-de9aa6928dd5'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '204':
          description: ''
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users/by-email/{email}/deactivate:
    post:
      summary: Deactivate User by Email
      description: 'Deactivate a user, identified by email: revoke all of their organization access and disable their sign-in, keeping the account so it can be restored. The user still resolves by id and by email with an empty organizations array, and drops out of organization user listings. Reversible through Reactivate User. Repeating the call is a no-op.'
      operationId: deactivate-user-by-email
      parameters:
      - name: email
        in: path
        description: The user's email address.
        required: true
        schema:
          $ref: '#/components/schemas/email-9ec7a2c8-b487-4a52-8e53-f47e2e6299b1'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '204':
          description: ''
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users/by-email/{email}/reactivate:
    post:
      summary: Reactivate User by Email
      description: 'Restore a deactivated user, identified by email: re-enable their sign-in and give them access to the organizations in the request body. That access is the set they end up with, not an addition to whatever they held before deactivation. The user keeps the group-level role they held before deactivation; supply organizationGroupRole only to change it on the way back in. Reactivating an active user simply applies the access in the body.'
      operationId: reactivate-user-by-email
      parameters:
      - name: email
        in: path
        description: The user's email address.
        required: true
        schema:
          $ref: '#/components/schemas/email-c7deb42d-a6bc-4791-b06e-058ce32111e8'
      tags:
      - Users
      security:
      - popp_api_key: []
      requestBody:
        description: The organization access to restore.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReactivateUserRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users/by-email/{email}/sign-out:
    post:
      summary: Sign Out User by Email
      description: Sign a user out of all of their active sessions, identified by email.
      operationId: sign-out-user-by-email
      parameters:
      - name: email
        in: path
        description: The user's email address.
        required: true
        schema:
          $ref: '#/components/schemas/email-f8e7b5d9-eed7-4b7b-83e1-b15551158ddc'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '204':
          description: ''
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users/{id}:
    get:
      summary: Get User
      description: Get a single user, with their per-organization access, by Popp user id.
      operationId: get-user
      parameters:
      - name: id
        in: path
        description: The Popp user id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
    patch:
      summary: Update User
      description: Update a user's name, organization access and/or group-level role. The organizations array uses replace-semantics (send the full desired set), while a field you omit is left unchanged; name each organization either by its Popp organizationId or by your own externalOrganizationId (exactly one per entry).
      operationId: update-user
      parameters:
      - name: id
        in: path
        description: The Popp user id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      tags:
      - Users
      security:
      - popp_api_key: []
      requestBody:
        description: The updated name, organization access and/or group role.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
    delete:
      summary: Delete User
      description: 'Permanently delete a user. **This cannot be undone.** Their sign-in is removed, all organization access is revoked and their personal details are erased. Records they created, such as campaigns and conversations, are kept and still show them as the author. Their email address becomes free to invite again. Returns 409 if the user still has an enabled API key: revoke it first, or every call made with that key will stop working. To remove access reversibly, use Deactivate User instead.'
      operationId: delete-user
      parameters:
      - name: id
        in: path
        description: The Popp user id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '204':
          description: ''
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '409':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users/{id}/deactivate:
    post:
      summary: Deactivate User
      description: 'Deactivate a user: revoke all of their organization access and disable their sign-in, keeping the account so it can be restored. The user still resolves by id and with an empty organizations array, and drops out of organization user listings. Reversible through Reactivate User. Repeating the call is a no-op.'
      operationId: deactivate-user
      parameters:
      - name: id
        in: path
        description: The Popp user id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '204':
          description: ''
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users/{id}/reactivate:
    post:
      summary: Reactivate User
      description: 'Restore a deactivated user: re-enable their sign-in and give them access to the organizations in the request body. That access is the set they end up with, not an addition to whatever they held before deactivation. The user keeps the group-level role they held before deactivation; supply organizationGroupRole only to change it on the way back in. Reactivating an active user simply applies the access in the body.'
      operationId: reactivate-user
      parameters:
      - name: id
        in: path
        description: The Popp user id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      tags:
      - Users
      security:
      - popp_api_key: []
      requestBody:
        description: The organization access to restore.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReactivateUserRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/users/{id}/sign-out:
    post:
      summary: Sign Out User
      description: Sign a user out of all of their active sessions.
      operationId: sign-out-user
      parameters:
      - name: id
        in: path
        description: The Popp user id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      tags:
      - Users
      security:
      - popp_api_key: []
      responses:
        '204':
          description: ''
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
components:
  schemas:
    ReactivateUserRequest:
      title: ReactivateUserRequest
      type: object
      required:
      - organizations
      properties:
        organizationGroupRole:
          type: string
          description: 'The group-level role to restore. Optional: omitted, the user keeps the role they had before deactivation. Send it only to change that role on the way back in.'
          enum:
          - ORGANIZATION_GROUP_ADMIN
          - ORGANIZATION_GROUP_MEMBER
        organizations:
          type: array
          minItems: 1
          description: The organizations the user regains access to. This is the access they end up with, not an addition to what they had before deactivation.
          items:
            type: object
            description: Names one organization either by its Popp id or by your own externalOrganizationId, never both. A hidden organization is not a valid target under either id and returns 404.
            oneOf:
            - title: By Popp organization id
              type: object
              required:
              - organizationId
              properties:
                organizationId:
                  type: string
                  description: The Popp organization id.
                role:
                  type: string
                  enum:
                  - ADMIN
                  - MEMBER
              additionalProperties: false
            - title: By your own external id
              type: object
              required:
              - externalOrganizationId
              properties:
                externalOrganizationId:
                  type: string
                  description: Your own id for the organization, as set through PATCH /v1/organizations/{id}.
                role:
                  type: string
                  enum:
                  - ADMIN
                  - MEMBER
              additionalProperties: false
      additionalProperties: false
    auth_service_email:
      type: string
    email-9ec7a2c8-b487-4a52-8e53-f47e2e6299b1:
      type: string
      format: email
    nextToken:
      type: string
    UpdateUserRequest:
      title: UpdateUserRequest
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: The user's display name. Left unchanged when omitted.
        organizationGroupRole:
          type: string
          enum:
          - ORGANIZATION_GROUP_ADMIN
          - ORGANIZATION_GROUP_MEMBER
        organizations:
          type: array
          items:
            type: object
            description: Names one organization either by its Popp id or by your own externalOrganizationId, never both. A hidden organization is not a valid target under either id and returns 404.
            oneOf:
            - title: By Popp organization id
              type: object
              required:
              - organizationId
              properties:
                organizationId:
                  type: string
                  description: The Popp organization id.
                role:
                  type: string
                  enum:
                  - ADMIN
                  - MEMBER
              additionalProperties: false
            - title: By your own external id
              type: object
              required:
              - externalOrganizationId
              properties:
                externalOrganizationId:
                  type: string
                  description: Your own id for the organization, as set through PATCH /v1/organizations/{id}.
                role:
                  type: string
                  enum:
                  - ADMIN
                  - MEMBER
              additionalProperties: false
      additionalProperties: false
    email-36a90113-55ff-4550-a801-6fdb688e2ce8:
      type: string
      format: email
    ListUsersResponse:
      type: object
      properties:
        items:
          type: array
          description: Users in the organization group, each with their per-organization access.
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type:
                - string
                - 'null'
              email:
                type: string
                format: email
              organizationGroupRole:
                type:
                - string
                - 'null'
                enum:
                - ORGANIZATION_GROUP_ADMIN
                - ORGANIZATION_GROUP_MEMBER
              organizations:
                type: array
                items:
                  type: object
                  properties:
                    organizationId:
                      type: string
                    externalOrganizationId:
                      type:
                      - string
                      - 'null'
                    role:
                      type: string
                      enum:
                      - ADMIN
                      - MEMBER
                  required:
                  - organizationId
                  - externalOrganizationId
                  - role
                  additionalProperties: false
            required:
            - id
            - name
            - email
            - organizationGroupRole
            - organizations
            additionalProperties: false
        nextToken:
          type:
          - string
          - 'null'
          description: Pass back as `nextToken` to fetch the next page. Null when there are no more results.
      required:
      - items
      - nextToken
      additionalProperties: false
    auth_service_limit:
      type: integer
      minimum: 1
      maximum: 50
    email-bb440892-608c-4cfb-a29a-de9aa6928dd5:
      type: string
      format: email
    User:
      title: User
      description: A Popp user with their per-organization access
      type: object
      required:
      - id
      - name
      - email
      - organizationGroupRole
      - organizations
      properties:
        id:
          type: string
          description: Unique Popp identifier for the user
        name:
          type:
          - string
          - 'null'
          description: The user's display name
        email:
          type: string
          format: email
          description: The user's email address
        organizationGroupRole:
          type:
          - string
          - 'null'
          enum:
          - ORGANIZATION_GROUP_ADMIN
          - ORGANIZATION_GROUP_MEMBER
          description: The user's role within the organization group
        organizations:
          type: array
          description: The organizations the user can access, with their role in each
          items:
            type: object
            required:
            - organizationId
            - externalOrganizationId
            - role
            properties:
              organizationId:
                type: string
                description: Popp organization id
              externalOrganizationId:
                type:
                - string
                - 'null'
                description: Your external id for the organization, if one is set
              role:
                type: string
                enum:
                - ADMIN
                - MEMBER
                description: The user's role in this organization
            additionalProperties: false
      additionalProperties: false
    ErrorResponse:
      type: object
    limit-27c292e0-baed-45b9-91e6-4dbd3491ffdd:
      type: integer
      minimum: 1
      maximum: 50
    id:
      type: string
    email-f8e7b5d9-eed7-4b7b-83e1-b15551158ddc:
      type: string
      format: email
    CreateUserRequest:
      title: CreateUserRequest
      type: object
      required:
      - email
      - organizations
      properties:
        email:
          type: string
          format: email
        name:
          type: string
        organizationGroupRole:
          type: string
          enum:
          - ORGANIZATION_GROUP_ADMIN
          - ORGANIZATION_GROUP_MEMBER
        organizations:
          type: array
          minItems: 1
          items:
            type: object
            description: Names one organization either by its Popp id or by your own externalOrganizationId, never both. A hidden organization is not a valid target under either id and returns 404.
            oneOf:
            - title: By Popp organization id
              type: object
              required:
              - organizationId
              properties:
                organizationId:
                  type: string
                  description: The Popp organization id.
                role:
                  type: string
                  enum:
                  - ADMIN
                  - MEMBER
              additionalProperties: false
            - title: By your own external id
              type: object
              required:
              - externalOrganizationId
              properties:
                externalOrganizationId:
                  type: string
                  description: Your own id for the organization, as set through PATCH /v1/organizations/{id}.
                role:
                  type: string
                  enum:
                  - ADMIN
                  - MEMBER
              additionalProperties: false
        sendInvite:
          type: boolean
      additionalProperties: false
    email-c7deb42d-a6bc-4791-b06e-058ce32111e8:
      type: string
      format: email
  securitySchemes:
    popp_api_key:
      description: Your Popp API key for authentication
      type: apiKey
      name: x-api-key
      in: header
    organization_id:
      description: Your organization's unique identifier
      type: apiKey
      name: x-organization-id
      in: header
x-provenance:
  method: searched
  source: https://docs.joinpopp.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.joinpopp.com/reference/add-candidates-to-list-by-external-id.md
  - https://docs.joinpopp.com/reference/add-candidates-to-list.md
  - https://docs.joinpopp.com/reference/archive-analysis.md
  - https://docs.joinpopp.com/reference/archive-document-type.md
  - https://docs.joinpopp.com/reference/archive-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/archive-workflow.md
  - https://docs.joinpopp.com/reference/bulk-create-conversations.md
  - https://docs.joinpopp.com/reference/cancel-booking.md
  - https://docs.joinpopp.com/reference/cancel-workflow-run.md
  - https://docs.joinpopp.com/reference/create-analysis-candidate.md
  - https://docs.joinpopp.com/reference/create-analysis.md
  - https://docs.joinpopp.com/reference/create-campaign.md
  - https://docs.joinpopp.com/reference/create-candidate-list.md
  - https://docs.joinpopp.com/reference/create-candidate-note-by-external-id.md
  - https://docs.joinpopp.com/reference/create-candidate-note.md
  - https://docs.joinpopp.com/reference/create-candidate.md
  - https://docs.joinpopp.com/reference/create-conversation.md
  - https://docs.joinpopp.com/reference/create-custom-field.md
  - https://docs.joinpopp.com/reference/create-document-credential.md
  - https://docs.joinpopp.com/reference/create-document-type.md
  - https://docs.joinpopp.com/reference/create-meeting-template.md
  - https://docs.joinpopp.com/reference/create-organization-config.md
  - https://docs.joinpopp.com/reference/create-scheduling-conversation.md
  - https://docs.joinpopp.com/reference/create-user.md
  - https://docs.joinpopp.com/reference/create-webhook.md
  - https://docs.joinpopp.com/reference/create-workflow.md
  - https://docs.joinpopp.com/reference/deactivate-user-by-email.md
  - https://docs.joinpopp.com/reference/deactivate-user.md
  - https://docs.joinpopp.com/reference/delete-candidate-by-email.md
  - https://docs.joinpopp.com/reference/delete-candidate-by-external-id.md
  - https://docs.joinpopp.com/reference/delete-candidate-by-phone-number.md
  - https://docs.joinpopp.com/reference/delete-candidate-list-by-external-id.md
  - https://docs.joinpopp.com/reference/delete-candidate-list.md
  - https://docs.joinpopp.com/reference/delete-candidate-note.md
  - https://docs.joinpopp.com/reference/delete-candidate.md
  - https://docs.joinpopp.com/reference/delete-custom-field.md
  - https://docs.joinpopp.com/reference/delete-document-credential.md
  - https://docs.joinpopp.com/reference/delete-document-type.md
  - https://docs.joinpopp.com/reference/delete-meeting-template.md
  - https://docs.joinpopp.com/reference/delete-tag.md
  - https://docs.joinpopp.com/reference/delete-user-by-email.md
  - https://docs.joinpopp.com/reference/delete-user.md
  - https://docs.joinpopp.com/reference/delete-webhook.md
  - https://docs.joinpopp.com/reference/download-media.md
  - https://docs.joinpopp.com/reference/generate-preferred-answer-requirements.md
  - https://docs.joinpopp.com/reference/generate-questions.md
  - https://docs.joinpopp.com/reference/generate-requirements.md
  - https://docs.joinpopp.com/reference/get-analysis.md
  - https://docs.joinpopp.com/reference/get-booking.md
  - https://docs.joinpopp.com/reference/get-campaign.md
  - https://docs.joinpopp.com/reference/get-candidate-by-external-id.md
  - https://docs.joinpopp.com/reference/get-candidate-list-by-external-id.md
  - https://docs.joinpopp.com/reference/get-candidate-list.md
  - https://docs.joinpopp.com/reference/get-candidate-profile-by-external-id.md
  - https://docs.joinpopp.com/reference/get-candidate.md
  - https://docs.joinpopp.com/reference/get-conversation.md
  - https://docs.joinpopp.com/reference/get-custom-field.md
  - https://docs.joinpopp.com/reference/get-document-media.md
  - https://docs.joinpopp.com/reference/get-document-type.md
  - https://docs.joinpopp.com/reference/get-document.md
  - https://docs.joinpopp.com/reference/get-meeting-template.md
  - https://docs.joinpopp.com/reference/get-organization-config-by-external-id.md
  - https://docs.joinpopp.com/reference/get-organization-config.md
  - https://docs.joinpopp.com/reference/get-organization-details.md
  - https://docs.joinpopp.com/reference/get-user-by-email.md
  - https://docs.joinpopp.com/reference/get-user-calendar.md
  - https://docs.joinpopp.com/reference/get-user.md
  - https://docs.joinpopp.com/reference/get-workflow-analysis-application.md
  - https://docs.joinpopp.com/reference/get-workflow-analysis.md
  - https://docs.joinpopp.com/reference/get-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/get-workflow-run.md
  - https://docs.joinpopp.com/reference/get-workflow.md
  - https://docs.joinpopp.com/reference/hand-conversation-to-agent.md
  - https://docs.joinpopp.com/reference/invite-calendar-contact.md
  - https://docs.joinpopp.com/reference/list-agents.md
  - https://docs.joinpopp.com/reference/list-analyses.md
  - https://docs.joinpopp.com/reference/list-ats-job-stages.md
  - https://docs.joinpopp.com/reference/list-ats-jobs.md
  - https://docs.joinpopp.com/reference/list-ats-rejection-reasons.md
  - https://docs.joinpopp.com/reference/list-bookings.md
  - https://docs.joinpopp.com/reference/list-campaigns.md
  - https://docs.joinpopp.com/reference/list-candidate-lists.md
  - https://docs.joinpopp.com/reference/list-candidate-notes-by-external-id.md
  - https://docs.joinpopp.com/reference/list-candidate-notes.md
  - https://docs.joinpopp.com/reference/list-conversation-documents.md
  - https://docs.joinpopp.com/reference/list-conversation-messages.md
  - https://docs.joinpopp.com/reference/list-conversations.md
  - https://docs.joinpopp.com/reference/list-custom-fields.md
  - https://docs.joinpopp.com/reference/list-document-credentials.md
  - https://docs.joinpopp.com/reference/list-document-types.md
  - https://docs.joinpopp.com/reference/list-meeting-templates.md
  - https://docs.joinpopp.com/reference/list-organization-users.md
  - https://docs.joinpopp.com/reference/list-organizations.md
  - https://docs.joinpopp.com/reference/list-tags.md
  - https://docs.joinpopp.com/reference/list-templates.md
  - https://docs.joinpopp.com/reference/list-user-calendars.md
  - https://docs.joinpopp.com/reference/list-users.md
  - https://docs.joinpopp.com/reference/list-webhook-events.md
  - https://docs.joinpopp.com/reference/list-webhooks.md
  - https://docs.joinpopp.com/reference/list-workflow-analysis-application-history.md
  - https://docs.joinpopp.com/reference/list-workflow-analysis-applications.md
  - https://docs.joinpopp.com/reference/list-workflow-runs.md
  - https://docs.joinpopp.com/reference/list-workflows.md
  - https://docs.joinpopp.com/reference/parse-availability.md
  - https://docs.joinpopp.com/reference/pause-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/pause-workflow.md
  - https://docs.joinpopp.com/reference/process-document.md
  - https://docs.joinpopp.com/reference/publish-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/publish-workflow.md
  - https://docs.joinpopp.com/reference/reactivate-user-by-email.md
  - https://docs.joinpopp.com/reference/reactivate-user.md
  - https://docs.joinpopp.com/reference/remove-candidate-document-by-external-id.md
  - https://docs.joinpopp.com/reference/remove-candidate-document.md
  - https://docs.joinpopp.com/reference/remove-candidates-from-list-by-external-id.md
  - https://docs.joinpopp.com/reference/remove-candidates-from-list.md
  - https://docs.joinpopp.com/reference/reparse-candidate-cv-by-external-id.md
  - https://docs.joinpopp.com/reference/reparse-candidate-cv.md
  - https://docs.joinpopp.com/reference/resend-booking-url.md
  - https://docs.joinpopp.com/reference/resume-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/resume-workflow.md
  - https://docs.joinpopp.com/reference/send-conversation-message.md
  - https://docs.joinpopp.com/reference/set-user-calendar-availability.md
  - https://docs.joinpopp.com/reference/sign-out-user-by-email.md
  - https://docs.joinpopp.com/reference/sign-out-user.md
  - https://docs.joinpopp.com/reference/start-workflow-runs-by-external-id.md
  - https://docs.joinpopp.com/reference/start-workflow-runs.md
  - https://docs.joinpopp.com/reference/stop-campaign.md
  - https://docs.joinpopp.com/reference/takeover-conversation.md
  - https://docs.joinpopp.com/reference/update-analysis.md
  - https://docs.joinpopp.com/reference/update-booking.md
  - https://docs.joinpopp.com/reference/update-campaign.md
  - https://docs.joinpopp.com/reference/update-candidate-by-external-id.md
  - https://docs.joinpopp.com/reference/update-candidate-list-by-external-id.md
  - https://docs.joinpopp.com/reference/update-candidate-list.md
  - https://docs.joinpopp.com/reference/update-candidate-note.md
  - https://docs.joinpopp.com/reference/update-candidate.md
  - https://docs.joinpopp.com/reference/update-custom-field.md
  - https://docs.joinpopp.com/reference/update-document-credential.md
  - https://docs.joinpopp.com/reference/update-document-type.md
  - https://docs.joinpopp.com/reference/update-meeting-template.md
  - https://docs.joinpopp.com/reference/update-organization-config-by-external-id.md
  - https://docs.joinpopp.com/reference/update-organization-config.md
  - https://docs.joinpopp.com/reference/update-organization-details.md
  - https://docs.joinpopp.com/reference/update-requirements-and-reanalyse.md
  - https://docs.joinpopp.com/reference/update-user-by-email.md
  - https://docs.joinpopp.com/reference/update-user.md
  - https://docs.joinpopp.com/reference/update-webhook.md
  - https://docs.joinpopp.com/reference/update-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/update-workflow.md
  merge:
    pages: 149
    deduped: 618
    conflicts_kept_first: 0