---
title: "Returns optin configuration"
method: GET
path: "/v1/applets/{id}/optin/configuration"
tags: ["applets"]
---

# Returns optin configuration

`GET /v1/applets/{id}/optin/configuration`

## Path parameters

- `id` integer, required

## Response `200`

OK

- AppletOptInConfigurationResponseDto
  - `components` AppletOptInConfigurationComponentsRequestDto
    - `title` AppletOptInConfigurationComponentFieldRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `intro` AppletOptInConfigurationComponentTextareaRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `contactGroups` AppletOptInConfigurationComponentContactGroupsRequestDto, required
      - `visible` boolean — visible
      - `position` integer — position
      - `contactGroupIds` integer[] — contact group ids
    - `firstName` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `lastName` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `emailAddress` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `contactTitle` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `nickname` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `landline` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `fax` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `birthday` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `homepage` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `instantMessenger` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `skype` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `remarks` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `street` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `zipCode` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `city` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `country` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `company` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `department` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `bureau` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `position` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `jobTitle` AppletOptInConfigurationComponentContactFieldRequestDto
      - `content` string — content
      - `required` boolean — required
      - `position` integer — position
    - `msisdn` AppletOptInConfigurationComponentMsisdnRequestDto, required
      - `content` string — content
      - `position` integer — position
      - `optinChannels` string[] — opt in channels
    - `logo` AppletOptInConfigurationComponentAttachmentRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `attachmentId` integer — attachment id
      - `attachmentMimeType` string — attachment mime type
    - `appletTitle` AppletOptInConfigurationComponentFieldRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `companyName` AppletOptInConfigurationComponentFieldRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `labelChannelSelection` AppletOptInConfigurationComponentFieldRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `labelContactGroupSelection` AppletOptInConfigurationComponentFieldRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `labelWhatsappMsisdn` AppletOptInConfigurationComponentFieldRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `titleMsisdnVerificationSuccessful` AppletOptInConfigurationComponentFieldRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `descriptionMsisdnVerificationSuccessful` AppletOptInConfigurationComponentTextareaRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
    - `termsAndConditions` AppletOptInConfigurationComponentTermsAndConditionsRequestDto
      - `visible` boolean — visible
      - `position` integer — position
      - `content` string — content
      - `required` boolean — required
  - `messages` AppletOptInConfigurationMessagesRequestDto
    - `pinSms` AppletOptInConfigurationMessageRequestDto, required
      - `content` string — content
    - `welcomeSms` AppletOptInConfigurationActivatableMessageRequestDto
      - `content` string — content
      - `active` boolean — active
    - `welcomeWhatsapp` AppletOptInConfigurationActivatableMessageRequestDto
      - `content` string — content
      - `active` boolean — active
    - `isBlacklisted` AppletOptInConfigurationActivatableMessageRequestDto
      - `content` string — content
      - `active` boolean — active
    - `whatsappMsisdn` AppletOptInConfigurationActivatableMessageRequestDto
      - `content` string — content
      - `active` boolean — active
  - `kioskMode` boolean — kiosk mode
  - `whatsappAvailable` boolean — whatsapp available
  - `smsAvailable` boolean — sms available
  - `links` Link[] — links
    - `rel` string
    - `href` string

## Other responses

- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.dev/linkmobility/apis/untitled-api.md) · [All operations](https://skmtc.dev/linkmobility/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/linkmobility/untitled-api/revisions/db84f79799b9/schema)