---
title: "Send opt-in request to conversation`s contact"
method: POST
path: "/contacts/opt-in/request/{conversation}"
tags: ["Contacts"]
---

# Send opt-in request to conversation`s contact

`POST /contacts/opt-in/request/{conversation}`

REQUIRED SCOPES <code>['contacts:write']</code><br> This endpoint enables an opt-in request feature within your application in the settings.<br><br> As soon as the feature becomes enabled by the user, this will require every contact to confirm their phone number in order to start a conversation with the user. This endpoint will make it possibe to make a similar request from the conversation window through the `Send confirmation`  button.

## Path parameters

- `conversation` integer, required

## Response `200`

OK

- object
  - `contact` ContactResource — Class ContactResource
    - `id` integer — Returns the contact in array format.
    - `owner_id` integer
    - `color` string
    - `first_name` string
    - `last_name` string
    - `full_name` string
    - `email` string
    - `photo_url` string
    - `number` string
    - `country` string
    - `country_calling_code` string
    - `national_number` string
    - `typeted_number` string
    - `is_blocked` boolean
    - `opt_out` boolean
    - `opt_out_at` string
    - `opt_in_request_at` string
    - `opt_in_requests` object[]
      - `number_id` integer
    - `opt_in_at` string
    - `shortcode_opt_outs` object[]
      - `id` integer
      - `number_id` integer
      - `name` string
      - `disabled` boolean
      - `timestamp` string
      - `value` boolean
    - `created_at` string
    - `updated_at` string
    - `integration_vendor_id` integer
    - `prevent_autolink` boolean
    - `integration` object[]
      - `id` integer
      - `key` string
      - `name` string
      - `photo_url` string
    - `custom_fields` ContactCustomFieldResource[]
      - `id` integer
      - `custom_field_id` integer
      - `contact_id` integer
      - `field_key` string
      - `organization_id` integer
      - `text` string
      - `number` integer
      - `date` string
      - `created_at` string
      - `updated_at` string
      - `value` object[]
        - `type` string
        - `value` string
    - `tags` ContactTagResource[]
      - `id` integer
      - `name` string
      - `label` string
      - `created_at` string
    - `notes` object[]
      - `id` integer
      - `text` string
      - `created_at` string
      - `updated_at` string
  - `message` MessageResource — Class MessageResource
    - `id` integer
    - `conversation_id` integer
    - `automated` boolean
    - `status` string
    - `type` string
    - `mms_status` string
    - `body` string
    - `body_raw` string
    - `has_tagging` boolean
    - `icon` string
    - `received_at` string
    - `send_at` string
    - `queued_at` string
    - `sent_at` string
    - `delivered_at` string
    - `failed_at` string
    - `failed_reason` string
    - `created_at` string
    - `stop_on_response` boolean
    - `is_hipaa` boolean
    - `record` object
      - `id` integer
      - `message_id` integer
      - `sid` string
      - `record_id` string
      - `duration` integer
      - `status` string
      - `url` string
      - `is_voicemail` boolean
      - `created_at` string
      - `updated_at` string
    - `user_id` integer
    - `source_id` string
    - `source` string
    - `contact` ContactResource — Class ContactResource
      - `id` integer — Returns the contact in array format.
      - `owner_id` integer
      - `color` string
      - `first_name` string
      - `last_name` string
      - `full_name` string
      - `email` string
      - `photo_url` string
      - `number` string
      - `country` string
      - `country_calling_code` string
      - `national_number` string
      - `typeted_number` string
      - `is_blocked` boolean
      - `opt_out` boolean
      - `opt_out_at` string
      - `opt_in_request_at` string
      - `opt_in_requests` object[]
        - `number_id` integer
      - `opt_in_at` string
      - `shortcode_opt_outs` object[]
        - `id` integer
        - `number_id` integer
        - `name` string
        - `disabled` boolean
        - `timestamp` string
        - `value` boolean
      - `created_at` string
      - `updated_at` string
      - `integration_vendor_id` integer
      - `prevent_autolink` boolean
      - `integration` object[]
        - `id` integer
        - `key` string
        - `name` string
        - `photo_url` string
      - `custom_fields` ContactCustomFieldResource[]
        - `id` integer
        - `custom_field_id` integer
        - `contact_id` integer
        - `field_key` string
        - `organization_id` integer
        - `text` string
        - `number` integer
        - `date` string
        - `created_at` string
        - `updated_at` string
        - `value` object[]
          - `type` string
          - `value` string
      - `tags` ContactTagResource[]
        - `id` integer
        - `name` string
        - `label` string
        - `created_at` string
      - `notes` object[]
        - `id` integer
        - `text` string
        - `created_at` string
        - `updated_at` string
    - `user` UserResource — Class UserResource
      - `id` integer
      - `email` string
      - `first_name` string
      - `last_name` string
      - `full_name` string
      - `role` string
      - `inbox_id` integer
      - `organization_id` integer
      - `photo_url` string
      - `unread` integer
      - `number` string
      - `formatted_number` string
      - `isRingEverywhere` boolean
      - `organizationNumber` object[]
        - `id` integer
        - `country` string
        - `number` string
        - `formatted_number` string
        - `mms` string
      - `userPermissions` string[]
    - `pending_mentions` UserResource[]
      - `id` integer
      - `email` string
      - `first_name` string
      - `last_name` string
      - `full_name` string
      - `role` string
      - `inbox_id` integer
      - `organization_id` integer
      - `photo_url` string
      - `unread` integer
      - `number` string
      - `formatted_number` string
      - `isRingEverywhere` boolean
      - `organizationNumber` object[]
        - `id` integer
        - `country` string
        - `number` string
        - `formatted_number` string
        - `mms` string
      - `userPermissions` string[]
    - `media` MessageMediaResource[]
      - `id` integer
      - `content_type` string
      - `source` string
      - `source_short` string
      - `created_at` string

---

[API](https://skmtc.net/salesmessage/apis/salesmessage-public-api.md) · [All operations](https://skmtc.net/salesmessage/apis/salesmessage-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/salesmessage/salesmessage-public-api/revisions/e96b3e58b041/schema)