---
title: "Create attribute mapping for an inbound integration"
method: POST
path: "/api/public/v1/inbound-integration/{integrationId}/mapping"
tags: ["InboundIntegrationMappingResource"]
---

# Create attribute mapping for an inbound integration

`POST /api/public/v1/inbound-integration/{integrationId}/mapping`

## Request

- Base URL: `https://allquiet.app` (the document declares no server; this is the origin it was published from)
- URL: `https://allquiet.app/api/public/v1/inbound-integration/{integrationId}/mapping`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/allquiet/apis/all-quiet-public-api/docs/api/public/v1/inbound-integration/:integrationId/mapping/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates the attribute mapping for an inbound integration that has none yet.

**Required API key permissions**

- **Scope:** `inbound-integration-mappings:create`
- **Accepted key types:** organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
- **Access:** Access is checked against the specific resource (team or organization reachability).
- **Required team role (user-linked keys only):** Administrator
- Organization API keys are not subject to organization or team role checks.

## Path parameters

- `integrationId` string, uuid, required

## Query parameters

- `provision` boolean

## Request body

- AllQuietApiPublicInboundIntegrationsInboundIntegrationMappingResourceCreateRequest
  - `attributesMapping` AllQuietApiIntegrationsModelsAttributesMapping, required
    - `attributes` AllQuietApiIntegrationsModelsAttributeMapping[], required
      - `name` string, required
      - `isImage` boolean, nullable
      - `hideInPreviews` boolean, nullable
      - `isGroupingKey` boolean, nullable
      - `expand` boolean, nullable
      - `mappings` AllQuietApiIntegrationsModelsMapping[], required
        - `xPath` string, nullable
        - `jsonPath` string, nullable
        - `regex` string, nullable
        - `replace` string, nullable
        - `map` string, nullable
        - `static` string, nullable
    - `groupingWindowInSeconds` integer, nullable

## Response `200`

OK

- AllQuietApiPublicInboundIntegrationsInboundIntegrationResourceResponse
  - `id` string, uuid
  - `isProvisioned` boolean
  - `displayName` string, nullable
  - `type` string, nullable
  - `teamId` string, uuid
  - `labels` string[], nullable
  - `isMuted` boolean
  - `isInMaintenance` boolean
  - `webhookUrl` string, nullable
  - `snoozeSettings` AllQuietApiIntegrationsModelsSnoozeSettings
    - `snoozeWindowInMinutes` integer, nullable
    - `filters` AllQuietApiIntegrationsModelsSnoozeSettingsTimeFilter[], nullable
      - `selectedDays` string[], nullable
      - `from` string, time, nullable
      - `until` string, time, nullable
      - `snoozeWindowInMinutes` integer, nullable
      - `snoozeUntilAbsolute` string, time, nullable
      - `snoozeUntilWeekdayAbsolute` string, nullable
  - `noiseLimitInSeconds` integer, nullable
  - `webhookAuthentication` AllQuietApiIntegrationsModelsWebhookAuthentication
    - `privateIpFilter` string, nullable
    - `type` string, required
    - `bearer` AllQuietApiIntegrationsModelsWebhookAuthenticationBearer
      - `token` string, nullable
  - `integrationSettings` AllQuietApiPublicInboundIntegrationsInboundIntegrationResourceIntegrationSettingsResponse
    - `httpMonitoring` AllQuietApiIntegrationsHttpMonitoringIntegrationSettingsHttpMonitoring
      - `url` string, required
      - `method` string, required
      - `overrideAcceptedStatusCodes` integer[], nullable
      - `timeoutInMilliseconds` integer, required
      - `intervalInSeconds` integer, required
      - `maxRetries` integer
      - `authenticationType` string, nullable
      - `basicAuthenticationUserName` string, nullable
      - `basicAuthenticationPassword` string, nullable
      - `bearerAuthenticationToken` string, nullable
      - `headers` object, nullable
      - `body` string, nullable
      - `isPaused` boolean
      - `contentTest` string, nullable
      - `contentTestMode` string, nullable
      - `sslCertificateMaxAgeInDaysDegraded` integer, nullable
      - `sslCertificateMaxAgeInDaysDown` integer, nullable
      - `severityDegraded` string, nullable
      - `severityDown` string, nullable
      - `logResponseBody` boolean
      - `ignoreNonHttpErrors` boolean
      - `disableFollowRedirect` boolean
    - `heartbeatMonitor` AllQuietApiIntegrationsHeartbeatMonitorIntegrationSettingsHeartbeatMonitor
      - `intervalInSec` integer, required
      - `gracePeriodInSec` integer, required
      - `severity` string, required
    - `cronJobMonitor` AllQuietApiIntegrationsCronJobMonitorIntegrationSettingsCronJobMonitor
      - `gracePeriodInSec` integer, required
      - `severity` string, required
      - `cronExpression` string, required
      - `timeZoneId` string, required
    - `pingMonitor` AllQuietApiIntegrationsPingMonitorIntegrationSettingsPingMonitor
      - `host` string, required
      - `timeoutInMilliseconds` integer, required
      - `intervalInSeconds` integer, required
      - `maxRetries` integer
      - `isPaused` boolean
      - `severityDegraded` string, nullable
      - `severityDown` string, nullable
    - `email` AllQuietApiIntegrationsModelsIntegrationSettingsEmail
      - `emailAddress` string, nullable
      - `aliases` string[], nullable
    - `twilio` AllQuietApiIntegrationsModelsIntegrationSettingsTwilio
      - `accessSettings` AllQuietApiIntegrationsModelsTwilioInboundNumberSettings
        - `apiBaseDomain` string, nullable
        - `accountSid` string, nullable
        - `authToken` string, nullable
        - `phoneNumber` string, required
        - `phoneNumberSid` string, nullable
      - `callFlowConfig` AllQuietApiCallRoutingModelsInboundNumberCallFlowConfig
        - `welcomeMessage` AllQuietApiCallRoutingModelsInboundNumberPrompt
          - `type` string, nullable
          - `text` string, nullable
          - `locale` string, nullable
          - `voice` string, nullable
          - `audioFile` AllQuietApiCallRoutingModelsInboundNumberAudioFile
            - `objectKey` string, nullable
            - `fileName` string, nullable
            - `contentType` string, nullable
            - `fileSizeBytes` integer, nullable
            - `durationSeconds` integer, nullable
            - `uploadedAt` string, date-time, nullable
            - `uploadedByUserId` string, uuid, nullable
        - `callDisplayMode` string, nullable
        - `attachVoicemailTranscript` boolean
        - `callerAllowlist` string[], nullable
        - `callerBlocklist` string[], nullable
        - `route` AllQuietApiCallRoutingModelsInboundNumberRouteConfig
          - `teamId` string, uuid, nullable
          - `incidentSeverity` string, nullable
          - `directVoicemail` boolean
          - `sendToVoicemailIfNoResponse` boolean
          - `voicemailMessage` AllQuietApiCallRoutingModelsInboundNumberPrompt
            - `type` string, nullable
            - `text` string, nullable
            - `locale` string, nullable
            - `voice` string, nullable
            - `audioFile` AllQuietApiCallRoutingModelsInboundNumberAudioFile
              - …
          - `closingMessage` AllQuietApiCallRoutingModelsInboundNumberPrompt
            - `type` string, nullable
            - `text` string, nullable
            - `locale` string, nullable
            - `voice` string, nullable
            - `audioFile` AllQuietApiCallRoutingModelsInboundNumberAudioFile
              - …
          - `autoResolveOnAnswer` boolean
          - `skipAlreadyDialedNumbers` boolean
          - `maxUsersToTry` integer
          - `dialTimeoutPerUserInSeconds` integer
          - `acceptCallPrompt` AllQuietApiCallRoutingModelsInboundNumberPrompt
            - `type` string, nullable
            - `text` string, nullable
            - `locale` string, nullable
            - `voice` string, nullable
            - `audioFile` AllQuietApiCallRoutingModelsInboundNumberAudioFile
              - …
          - `targetConfirmGatherTimeoutSeconds` integer
          - `targetConfirmMaxAttempts` integer
        - `menu` AllQuietApiCallRoutingModelsInboundNumberMenuConfig
          - `options` AllQuietApiCallRoutingModelsInboundNumberMenuOption[], nullable
            - `key` string, nullable
            - `route` AllQuietApiCallRoutingModelsInboundNumberRouteConfig
              - …
          - `menuMaxAttempts` integer
          - `menuGatherTimeoutSeconds` integer
      - `providerWebhookId` string, nullable
      - `configurationStatus` AllQuietApiCallRoutingModelsCallRoutingConfigurationStatus
        - `lastUpdated` string, date-time, nullable
        - `validationStatus` string, nullable
        - `resolvedPhoneNumber` string, nullable
    - `bird` AllQuietApiIntegrationsModelsIntegrationSettingsBird
      - `accessSettings` AllQuietApiIntegrationsModelsBirdInboundNumberSettings
        - `apiBaseDomain` string, nullable
        - `accessKey` string, nullable
        - `webhookSigningKey` string, nullable
        - `workspaceId` string, nullable
        - `channelId` string, nullable
        - `phoneNumber` string, nullable
      - `callFlowConfig` AllQuietApiCallRoutingModelsInboundNumberCallFlowConfig
        - `welcomeMessage` AllQuietApiCallRoutingModelsInboundNumberPrompt
          - `type` string, nullable
          - `text` string, nullable
          - `locale` string, nullable
          - `voice` string, nullable
          - `audioFile` AllQuietApiCallRoutingModelsInboundNumberAudioFile
            - `objectKey` string, nullable
            - `fileName` string, nullable
            - `contentType` string, nullable
            - `fileSizeBytes` integer, nullable
            - `durationSeconds` integer, nullable
            - `uploadedAt` string, date-time, nullable
            - `uploadedByUserId` string, uuid, nullable
        - `callDisplayMode` string, nullable
        - `attachVoicemailTranscript` boolean
        - `callerAllowlist` string[], nullable
        - `callerBlocklist` string[], nullable
        - `route` AllQuietApiCallRoutingModelsInboundNumberRouteConfig
          - `teamId` string, uuid, nullable
          - `incidentSeverity` string, nullable
          - `directVoicemail` boolean
          - `sendToVoicemailIfNoResponse` boolean
          - `voicemailMessage` AllQuietApiCallRoutingModelsInboundNumberPrompt
            - `type` string, nullable
            - `text` string, nullable
            - `locale` string, nullable
            - `voice` string, nullable
            - `audioFile` AllQuietApiCallRoutingModelsInboundNumberAudioFile
              - …
          - `closingMessage` AllQuietApiCallRoutingModelsInboundNumberPrompt
            - `type` string, nullable
            - `text` string, nullable
            - `locale` string, nullable
            - `voice` string, nullable
            - `audioFile` AllQuietApiCallRoutingModelsInboundNumberAudioFile
              - …
          - `autoResolveOnAnswer` boolean
          - `skipAlreadyDialedNumbers` boolean
          - `maxUsersToTry` integer
          - `dialTimeoutPerUserInSeconds` integer
          - `acceptCallPrompt` AllQuietApiCallRoutingModelsInboundNumberPrompt
            - `type` string, nullable
            - `text` string, nullable
            - `locale` string, nullable
            - `voice` string, nullable
            - `audioFile` AllQuietApiCallRoutingModelsInboundNumberAudioFile
              - …
          - `targetConfirmGatherTimeoutSeconds` integer
          - `targetConfirmMaxAttempts` integer
        - `menu` AllQuietApiCallRoutingModelsInboundNumberMenuConfig
          - `options` AllQuietApiCallRoutingModelsInboundNumberMenuOption[], nullable
            - `key` string, nullable
            - `route` AllQuietApiCallRoutingModelsInboundNumberRouteConfig
              - …
          - `menuMaxAttempts` integer
          - `menuGatherTimeoutSeconds` integer
      - `providerWebhookId` string, nullable
      - `configurationStatus` AllQuietApiCallRoutingModelsCallRoutingConfigurationStatus
        - `lastUpdated` string, date-time, nullable
        - `validationStatus` string, nullable
        - `resolvedPhoneNumber` string, nullable
  - `isRedacted` boolean

---

[API](https://skmtc.dev/allquiet/apis/all-quiet-public-api.md) - [All operations](https://skmtc.dev/allquiet/apis/all-quiet-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/allquiet/apis/all-quiet-public-api/revisions/bd7da0475359?raw)