Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
appConfig

Create a new app config

post/v1/app-config

Request body

appIdstring required

app id

userIdstring

user id, if this person corresponds with a user

orgIdstring

org id, if this app config corresponds with an org

disabledFieldMappersstring[]

list of disabled inbound field mappers by id

enabledOutboundFieldMappersstring[]

list of enabled outbound field mappers by id

templateMatchersobject[]

template field matchers defined by a user

optionsobject

app specific options

disabledOutboundFieldMapperKeysstring[]

keys (mapper.key ?: charthopExpr) of shipped config-driven outbound field mappers disabled per install

Example request

{
  "appId": "588f7ee98f138b19220041a7",
  "userId": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "fieldMappers": [
    {
      "id": "588f7ee98f138b19220041a7"
    }
  ],
  "customFieldMappers": [
    {
      "id": "588f7ee98f138b19220041a7"
    }
  ],
  "customOutboundFieldMappers": [
    {
      "id": "588f7ee98f138b19220041a7",
      "valueMappers": [
        {
          "id": "588f7ee98f138b19220041a7"
        }
      ]
    }
  ],
  "disabledFieldMappers": [
    "588f7ee98f138b19220041a7"
  ],
  "enabledOutboundFieldMappers": [
    "588f7ee98f138b19220041a7"
  ]
}

Response

app config created

idstring

globally unique id

appIdstring required

app id

userIdstring

user id, if this person corresponds with a user

orgIdstring

org id, if this app config corresponds with an org

disabledFieldMappersstring[]

list of disabled inbound field mappers by id

enabledOutboundFieldMappersstring[]

list of enabled outbound field mappers by id

templateMatchersobject[]

template field matchers defined by a user

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

optionsobject

app specific options

disabledOutboundFieldMapperKeysstring[]

keys (mapper.key ?: charthopExpr) of shipped config-driven outbound field mappers disabled per install

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "appId": "588f7ee98f138b19220041a7",
  "userId": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "fieldMappers": [
    {
      "id": "588f7ee98f138b19220041a7"
    }
  ],
  "customFieldMappers": [
    {
      "id": "588f7ee98f138b19220041a7"
    }
  ],
  "defaultOutboundFieldMappers": [
    {
      "id": "588f7ee98f138b19220041a7",
      "valueMappers": [
        {
          "id": "588f7ee98f138b19220041a7"
        }
      ]
    }
  ],
  "customOutboundFieldMappers": [
    {
      "id": "588f7ee98f138b19220041a7",
      "valueMappers": [
        {
          "id": "588f7ee98f138b19220041a7"
        }
      ]
    }
  ],
  "disabledFieldMappers": [
    "588f7ee98f138b19220041a7"
  ],
  "enabledOutboundFieldMappers": [
    "588f7ee98f138b19220041a7"
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  }
}