openapi: 3.2.0 info: title: engagement-suite Pinned Messages API version: '1' servers: - url: https://cf-blast.livelikecdn.com/api/v1 security: - {} tags: - name: Pinned Messages paths: /pinned-messages/: post: summary: Create a pin message description: '' operationId: create-a-pin-message requestBody: content: application/json: schema: type: object properties: message_id: type: string description: A valid UUID generated while sending message message_payload: type: string description: A valid message json, that is being send format: json chat_room_id: type: string description: A valid chat room id, for which the message is being pinned responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"id\": \"ac0c3600-86ab-4cdb-8fa1-ef3862c28d6e\",\n \"url\": \"https://cf-blast.livelikecdn.com/api/v1/pinned-messages/ac0c3600-86ab-4cdb-8fa1-ef3862c28d6e/\",\n \"message_id\": \"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"message_payload\": {\n \"custom_data\": \"\",\n \"id\": \"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"filtered_sender_nickname\": null,\n \"sender_nickname\": \"Healthy Hawk\",\n \"message\": \"hhf\",\n \"created_at\": \"2021-11-25T10:35:55+0000\",\n \"filtered_message\": null,\n \"content_filter\": {},\n \"sender_image_url\": null,\n \"badge_image_url\": null,\n \"sender_id\": \"916f306c-fb75-46a1-b465-da843e72e132\",\n \"sender_profile_url\": \"https://cf-blast-dig.livelikecdn.com/api/v1/profiles/916f306c-fb75-46a1-b465-da843e72e132/\",\n \"program_date_time\": \"2021-11-25T10:36:27.935Z\",\n \"image_url\": \"https://cf-blast-storage-dig.livelikecdn.com/uploads/b6bbcbd4-1d25-40bc-9cb5-c67cceb923d1/0df95f33-a5db-4d9e-945f-39db7477c936.gif\",\n \"image_height\": \"123\",\n \"image_width\": \"220\"\n },\n \"chat_room_id\": \"46a975fc-49e1-4fc0-8239-25c566296b5e\",\n \"pinned_by_id\": \"b4d1acab-84b7-449d-8298-a5d55fcc8fce\",\n \"pinned_at\": \"2021-12-02T05:36:11.503033Z\",\n \"pinned_by\": {\n \"id\": \"b4d1acab-84b7-449d-8298-a5d55fcc8fce\",\n \"url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/\",\n \"created_at\": \"2021-11-23T12:14:24.961109Z\",\n \"nickname\": \"Minty Rusher\",\n \"custom_data\": null,\n \"points\": 0,\n \"badges\": [],\n \"badges_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badges/\",\n \"badge_progress_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badge-progress/\",\n \"subscribe_channel\": \"profile.b4d1acab-84b7-449d-8298-a5d55fcc8fce\",\n \"reported_count\": 0,\n \"chat_room_memberships_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/chat-room-memberships/\",\n \"reward_item_credit_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-credits/\",\n \"reward_item_debit_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-debits/\",\n \"reward_item_balances_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-balances/\",\n \"reward_item_transfer_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-transfers/\",\n \"block_profile_url\": \"https://cf-blast.livelikecdn.com/api/v1/profile-blocks/\",\n \"blocked_profiles_template_url\": \"https://cf-blast.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id}\"\n }\n}" schema: type: object properties: id: type: string example: ac0c3600-86ab-4cdb-8fa1-ef3862c28d6e url: type: string example: https://cf-blast.livelikecdn.com/api/v1/pinned-messages/ac0c3600-86ab-4cdb-8fa1-ef3862c28d6e/ message_id: type: string example: b3b62e23-f194-46e1-a37c-e4cdd3d6fef8 message_payload: type: object properties: custom_data: type: string example: '' id: type: string example: b3b62e23-f194-46e1-a37c-e4cdd3d6fef8 filtered_sender_nickname: {} sender_nickname: type: string example: Healthy Hawk message: type: string example: hhf created_at: type: string example: 2021-11-25T10:35:55+0000 filtered_message: {} content_filter: type: object properties: {} sender_image_url: {} badge_image_url: {} sender_id: type: string example: 916f306c-fb75-46a1-b465-da843e72e132 sender_profile_url: type: string example: https://cf-blast-dig.livelikecdn.com/api/v1/profiles/916f306c-fb75-46a1-b465-da843e72e132/ program_date_time: type: string example: '2021-11-25T10:36:27.935Z' image_url: type: string example: https://cf-blast-storage-dig.livelikecdn.com/uploads/b6bbcbd4-1d25-40bc-9cb5-c67cceb923d1/0df95f33-a5db-4d9e-945f-39db7477c936.gif image_height: type: string example: '123' image_width: type: string example: '220' chat_room_id: type: string example: 46a975fc-49e1-4fc0-8239-25c566296b5e pinned_by_id: type: string example: b4d1acab-84b7-449d-8298-a5d55fcc8fce pinned_at: type: string example: '2021-12-02T05:36:11.503033Z' pinned_by: type: object properties: id: type: string example: b4d1acab-84b7-449d-8298-a5d55fcc8fce url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/ created_at: type: string example: '2021-11-23T12:14:24.961109Z' nickname: type: string example: Minty Rusher custom_data: {} points: type: integer example: 0 default: 0 badges: type: array badges_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badges/ badge_progress_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badge-progress/ subscribe_channel: type: string example: profile.b4d1acab-84b7-449d-8298-a5d55fcc8fce reported_count: type: integer example: 0 default: 0 chat_room_memberships_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/chat-room-memberships/ reward_item_credit_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-credits/ reward_item_debit_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-debits/ reward_item_balances_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-balances/ reward_item_transfer_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-transfers/ block_profile_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profile-blocks/ blocked_profiles_template_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id} '400': description: '400' content: application/json: examples: Result: value: "{\n \"message_id\": [\n \"This field is required.\"\n ],\n \"message_payload\": [\n \"This field is required.\"\n ],\n \"chat_room_id\": [\n \"This field is required.\"\n ]\n}" schema: type: object properties: message_id: type: array items: type: string example: This field is required. message_payload: type: array items: type: string example: This field is required. chat_room_id: type: array items: type: string example: This field is required. '409': description: '409' content: application/json: examples: Result: value: "{\n \"detail\": \"Message is already Pinned\"\n}" schema: type: object properties: detail: type: string example: Message is already Pinned deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request POST 'https://cf-blast.livelikecdn.com/api/v1/pinned-messages/' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI0ZDFhY2FiLTg0YjctNDQ5ZC04Mjk4LWE1ZDU1ZmNjOGZjZSIsImNsaWVudF9pZCI6IlBITWdNbXRqcWRiR3ViaEs4eFJMNk43YzFpSHZFd2o1MTdlVFgzMzMiLCJhY2Nlc3NfdG9rZW4iOiJuSUlBVnoxNkMtbUwtbjNEOHBlYURMT1FpS0R2TkFJQjY1S2ZPczlOOFhNcTF2c0s2NDVtc0EiLCJpc19wcm9kdWNlciI6dHJ1ZSwiaXNzIjoiYmxhc3QiLCJpYXQiOjE2Mzc5MTM4MDd9.xiSxIa72PkedE2Fj_OzR_Sy5p7ciuahc-lR17Sgif2k' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"message_id\":\"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"message_payload\": {\n \"custom_data\":\"\",\n \"id\": \"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"filtered_sender_nickname\": null,\n \"sender_nickname\": \"Healthy Hawk\",\n \"message\": \"hhf\",\n \"created_at\": \"2021-11-25T10:35:55+0000\",\n \"filtered_message\": null,\n \"content_filter\": { },\n \"sender_image_url\": null,\n \"badge_image_url\": null,\n \"sender_id\": \"916f306c-fb75-46a1-b465-da843e72e132\",\n \"sender_profile_url\": \"https://cf-blast-dig.livelikecdn.com/api/v1/profiles/916f306c-fb75-46a1-b465-da843e72e132/\",\n \"program_date_time\": \"2021-11-25T10:36:27.935Z\",\n \"image_url\":\"https://cf-blast-storage-dig.livelikecdn.com/uploads/b6bbcbd4-1d25-40bc-9cb5-c67cceb923d1/0df95f33-a5db-4d9e-945f-39db7477c936.gif\",\n \"image_height\":\"123\",\n \"image_width\": \"220\"\n },\n \"chat_room_id\": \"46a975fc-49e1-4fc0-8239-25c566296b5e\"\n}'" - language: python code: "import requests\nimport json\n\nurl = \"https://cf-blast.livelikecdn.com/api/v1/pinned-messages/\"\n\npayload = json.dumps({\n \"message_id\": \"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"message_payload\": {\n \"custom_data\": \"\",\n \"id\": \"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"filtered_sender_nickname\": None,\n \"sender_nickname\": \"Healthy Hawk\",\n \"message\": \"hhf\",\n \"created_at\": \"2021-11-25T10:35:55+0000\",\n \"filtered_message\": None,\n \"content_filter\": {},\n \"sender_image_url\": None,\n \"badge_image_url\": None,\n \"sender_id\": \"916f306c-fb75-46a1-b465-da843e72e132\",\n \"sender_profile_url\": \"https://cf-blast-dig.livelikecdn.com/api/v1/profiles/916f306c-fb75-46a1-b465-da843e72e132/\",\n \"program_date_time\": \"2021-11-25T10:36:27.935Z\",\n \"image_url\": \"https://cf-blast-storage-dig.livelikecdn.com/uploads/b6bbcbd4-1d25-40bc-9cb5-c67cceb923d1/0df95f33-a5db-4d9e-945f-39db7477c936.gif\",\n \"image_height\": \"123\",\n \"image_width\": \"220\"\n },\n \"chat_room_id\": \"46a975fc-49e1-4fc0-8239-25c566296b5e\"\n})\nheaders = {\n 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI0ZDFhY2FiLTg0YjctNDQ5ZC04Mjk4LWE1ZDU1ZmNjOGZjZSIsImNsaWVudF9pZCI6IlBITWdNbXRqcWRiR3ViaEs4eFJMNk43YzFpSHZFd2o1MTdlVFgzMzMiLCJhY2Nlc3NfdG9rZW4iOiJuSUlBVnoxNkMtbUwtbjNEOHBlYURMT1FpS0R2TkFJQjY1S2ZPczlOOFhNcTF2c0s2NDVtc0EiLCJpc19wcm9kdWNlciI6dHJ1ZSwiaXNzIjoiYmxhc3QiLCJpYXQiOjE2Mzc5MTM4MDd9.xiSxIa72PkedE2Fj_OzR_Sy5p7ciuahc-lR17Sgif2k',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" samples-languages: - curl - python tags: - Pinned Messages get: summary: Get Pinned Message Info description: '' operationId: get-pinned-message-info parameters: - name: chat_room_id in: query description: required field required: true schema: type: string - name: ordering in: query description: ordering can be pinned_at to get first pinned messages first, and -pinned_at to get latest pinned messages first schema: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"abc917b9-421e-4b21-82f0-624c2fcbd7ff\",\n \"url\": \"https://cf-blast.livelikecdn.com/api/v1/pinned-messages/abc917b9-421e-4b21-82f0-624c2fcbd7ff/\",\n \"message_id\": \"922f38de-c4b4-49d9-9cce-89759eeac956\",\n \"message_payload\": {\n \"id\": \"922f38de-c4b4-49d9-9cce-89759eeac956\",\n \"sender_id\": \"b4d1acab-84b7-449d-8298-a5d55fcc8fce\",\n \"sender_nickname\": \"Minty Rusher\",\n \"sender_image_url\": null,\n \"sender_profile_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/\",\n \"badge_image_url\": null,\n \"created_at\": \"2021-12-02T06:37:47.416Z\",\n \"program_date_time\": null,\n \"message\": \"new text\",\n \"timetoken\": \"16384270682254224\",\n \"reactions\": {}\n },\n \"chat_room_id\": \"46a975fc-49e1-4fc0-8239-25c566296b5e\",\n \"pinned_by_id\": \"b4d1acab-84b7-449d-8298-a5d55fcc8fce\",\n \"pinned_at\": \"2021-12-02T06:49:57.602937Z\",\n \"pinned_by\": {\n \"id\": \"b4d1acab-84b7-449d-8298-a5d55fcc8fce\",\n \"url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/\",\n \"created_at\": \"2021-11-23T12:14:24.961109Z\",\n \"nickname\": \"Minty Rusher\",\n \"custom_data\": null,\n \"points\": 0,\n \"badges\": [],\n \"badges_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badges/\",\n \"badge_progress_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badge-progress/\",\n \"subscribe_channel\": \"profile.b4d1acab-84b7-449d-8298-a5d55fcc8fce\",\n \"reported_count\": 0,\n \"chat_room_memberships_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/chat-room-memberships/\",\n \"reward_item_credit_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-credits/\",\n \"reward_item_debit_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-debits/\",\n \"reward_item_balances_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-balances/\",\n \"reward_item_transfer_url\": \"https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-transfers/\",\n \"block_profile_url\": \"https://cf-blast.livelikecdn.com/api/v1/profile-blocks/\",\n \"blocked_profiles_template_url\": \"https://cf-blast.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id}\"\n }\n }\n ]\n}" schema: type: object properties: count: type: integer example: 1 default: 0 next: {} previous: {} results: type: array items: type: object properties: id: type: string example: abc917b9-421e-4b21-82f0-624c2fcbd7ff url: type: string example: https://cf-blast.livelikecdn.com/api/v1/pinned-messages/abc917b9-421e-4b21-82f0-624c2fcbd7ff/ message_id: type: string example: 922f38de-c4b4-49d9-9cce-89759eeac956 message_payload: type: object properties: id: type: string example: 922f38de-c4b4-49d9-9cce-89759eeac956 sender_id: type: string example: b4d1acab-84b7-449d-8298-a5d55fcc8fce sender_nickname: type: string example: Minty Rusher sender_image_url: {} sender_profile_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/ badge_image_url: {} created_at: type: string example: '2021-12-02T06:37:47.416Z' program_date_time: {} message: type: string example: new text timetoken: type: string example: '16384270682254224' reactions: type: object properties: {} chat_room_id: type: string example: 46a975fc-49e1-4fc0-8239-25c566296b5e pinned_by_id: type: string example: b4d1acab-84b7-449d-8298-a5d55fcc8fce pinned_at: type: string example: '2021-12-02T06:49:57.602937Z' pinned_by: type: object properties: id: type: string example: b4d1acab-84b7-449d-8298-a5d55fcc8fce url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/ created_at: type: string example: '2021-11-23T12:14:24.961109Z' nickname: type: string example: Minty Rusher custom_data: {} points: type: integer example: 0 default: 0 badges: type: array badges_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badges/ badge_progress_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/badge-progress/ subscribe_channel: type: string example: profile.b4d1acab-84b7-449d-8298-a5d55fcc8fce reported_count: type: integer example: 0 default: 0 chat_room_memberships_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/chat-room-memberships/ reward_item_credit_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-credits/ reward_item_debit_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-debits/ reward_item_balances_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-balances/ reward_item_transfer_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profiles/b4d1acab-84b7-449d-8298-a5d55fcc8fce/reward-item-transfers/ block_profile_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profile-blocks/ blocked_profiles_template_url: type: string example: https://cf-blast.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id} '400': description: '400' content: application/json: examples: Result: value: "{\n \"chat_room_id\": [\n \"This field is required.\"\n ]\n}" schema: type: object properties: chat_room_id: type: array items: type: string example: This field is required. deprecated: false x-readme: code-samples: - language: curl code: "curl --location --request GET 'https://cf-blast.livelikecdn.com/api/v1/pinned-messages/?chat_room_id=46a975fc-49e1-4fc0-8239-25c566296b5e' \\\n--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI0ZDFhY2FiLTg0YjctNDQ5ZC04Mjk4LWE1ZDU1ZmNjOGZjZSIsImNsaWVudF9pZCI6IlBITWdNbXRqcWRiR3ViaEs4eFJMNk43YzFpSHZFd2o1MTdlVFgzMzMiLCJhY2Nlc3NfdG9rZW4iOiJuSUlBVnoxNkMtbUwtbjNEOHBlYURMT1FpS0R2TkFJQjY1S2ZPczlOOFhNcTF2c0s2NDVtc0EiLCJpc19wcm9kdWNlciI6dHJ1ZSwiaXNzIjoiYmxhc3QiLCJpYXQiOjE2Mzc5MTM4MDd9.xiSxIa72PkedE2Fj_OzR_Sy5p7ciuahc-lR17Sgif2k' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"message_id\":\"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"message_payload\": {\n \"custom_data\":\"\",\n \"id\": \"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"filtered_sender_nickname\": null,\n \"sender_nickname\": \"Healthy Hawk\",\n \"message\": \"hhf\",\n \"created_at\": \"2021-11-25T10:35:55+0000\",\n \"filtered_message\": null,\n \"content_filter\": { },\n \"sender_image_url\": null,\n \"badge_image_url\": null,\n \"sender_id\": \"916f306c-fb75-46a1-b465-da843e72e132\",\n \"sender_profile_url\": \"https://cf-blast-dig.livelikecdn.com/api/v1/profiles/916f306c-fb75-46a1-b465-da843e72e132/\",\n \"program_date_time\": \"2021-11-25T10:36:27.935Z\",\n \"image_url\":\"https://cf-blast-storage-dig.livelikecdn.com/uploads/b6bbcbd4-1d25-40bc-9cb5-c67cceb923d1/0df95f33-a5db-4d9e-945f-39db7477c936.gif\",\n\"image_height\":\"123\",\n\"image_width\": \"220\"\n },\n \"chat_room_id\": \"46a975fc-49e1-4fc0-8239-25c566296b5e\"\n}'" - language: python code: "import requests\nimport json\n\nurl = \"https://cf-blast.livelikecdn.com/api/v1/pinned-messages/?chat_room_id=46a975fc-49e1-4fc0-8239-25c566296b5e\"\n\npayload = json.dumps({\n \"message_id\": \"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"message_payload\": {\n \"custom_data\": \"\",\n \"id\": \"b3b62e23-f194-46e1-a37c-e4cdd3d6fef8\",\n \"filtered_sender_nickname\": None,\n \"sender_nickname\": \"Healthy Hawk\",\n \"message\": \"hhf\",\n \"created_at\": \"2021-11-25T10:35:55+0000\",\n \"filtered_message\": None,\n \"content_filter\": {},\n \"sender_image_url\": None,\n \"badge_image_url\": None,\n \"sender_id\": \"916f306c-fb75-46a1-b465-da843e72e132\",\n \"sender_profile_url\": \"https://cf-blast-dig.livelikecdn.com/api/v1/profiles/916f306c-fb75-46a1-b465-da843e72e132/\",\n \"program_date_time\": \"2021-11-25T10:36:27.935Z\",\n \"image_url\": \"https://cf-blast-storage-dig.livelikecdn.com/uploads/b6bbcbd4-1d25-40bc-9cb5-c67cceb923d1/0df95f33-a5db-4d9e-945f-39db7477c936.gif\",\n \"image_height\": \"123\",\n \"image_width\": \"220\"\n },\n \"chat_room_id\": \"46a975fc-49e1-4fc0-8239-25c566296b5e\"\n})\nheaders = {\n 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI0ZDFhY2FiLTg0YjctNDQ5ZC04Mjk4LWE1ZDU1ZmNjOGZjZSIsImNsaWVudF9pZCI6IlBITWdNbXRqcWRiR3ViaEs4eFJMNk43YzFpSHZFd2o1MTdlVFgzMzMiLCJhY2Nlc3NfdG9rZW4iOiJuSUlBVnoxNkMtbUwtbjNEOHBlYURMT1FpS0R2TkFJQjY1S2ZPczlOOFhNcTF2c0s2NDVtc0EiLCJpc19wcm9kdWNlciI6dHJ1ZSwiaXNzIjoiYmxhc3QiLCJpYXQiOjE2Mzc5MTM4MDd9.xiSxIa72PkedE2Fj_OzR_Sy5p7ciuahc-lR17Sgif2k',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" samples-languages: - curl - python tags: - Pinned Messages /pinned-messages/{id}/: delete: summary: Unpin Message description: '' operationId: unpin-message responses: '204': description: '204' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '404': description: '404' content: application/json: examples: Result: value: "{\n \"detail\": \"Not found.\"\n}" schema: type: object properties: detail: type: string example: Not found. deprecated: false tags: - Pinned Messages x-readme-fauxas: true x-provenance: method: searched source: https://docs.livelike.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.livelike.com/reference/add-bulk-chat-memberships.md - https://docs.livelike.com/reference/add-members-to-group.md - https://docs.livelike.com/reference/add-quest-badges.md - https://docs.livelike.com/reference/award-a-badge-to-a-user.md - https://docs.livelike.com/reference/batch-invoke-reward-action.md - https://docs.livelike.com/reference/claim-user-quest-badges.md - https://docs.livelike.com/reference/claim-user-quest-rewards.md - https://docs.livelike.com/reference/create-a-base-role.md - https://docs.livelike.com/reference/create-a-cheer-meter.md - https://docs.livelike.com/reference/create-a-comment-board.md - https://docs.livelike.com/reference/create-a-comment.md - https://docs.livelike.com/reference/create-a-flair-assignment.md - https://docs.livelike.com/reference/create-a-flair-scope.md - https://docs.livelike.com/reference/create-a-flair.md - https://docs.livelike.com/reference/create-a-group.md - https://docs.livelike.com/reference/create-a-pin-message.md - https://docs.livelike.com/reference/create-a-pinned-comment.md - https://docs.livelike.com/reference/create-a-profile-block.md - https://docs.livelike.com/reference/create-a-profile-relationship.md - https://docs.livelike.com/reference/create-a-program-ban.md - https://docs.livelike.com/reference/create-a-redemption-key.md - https://docs.livelike.com/reference/create-a-registered-link.md - https://docs.livelike.com/reference/create-a-relationship-type.md - https://docs.livelike.com/reference/create-a-rich-post.md - https://docs.livelike.com/reference/create-a-social-embed.md - https://docs.livelike.com/reference/create-a-sticker.md - https://docs.livelike.com/reference/create-a-text-quiz.md - https://docs.livelike.com/reference/create-a-user-reaction.md - https://docs.livelike.com/reference/create-a-user-tier.md - https://docs.livelike.com/reference/create-a-video-alert.md - https://docs.livelike.com/reference/create-an-access-rule-for-muteglobally-mute.md - https://docs.livelike.com/reference/create-an-alert.md - https://docs.livelike.com/reference/create-an-image-number-prediction.md - https://docs.livelike.com/reference/create-an-image-quiz.md - https://docs.livelike.com/reference/create-an-image-slider.md - https://docs.livelike.com/reference/create-badge-1.md - https://docs.livelike.com/reference/create-comment-report.md - https://docs.livelike.com/reference/create-comments-ban.md - https://docs.livelike.com/reference/create-image-number-prediction-follow-up.md - https://docs.livelike.com/reference/create-image-number-prediction-option.md - https://docs.livelike.com/reference/create-image-poll.md - https://docs.livelike.com/reference/create-image-prediction-follow-up.md - https://docs.livelike.com/reference/create-image-prediction-option.md - https://docs.livelike.com/reference/create-poll-vote.md - https://docs.livelike.com/reference/create-profile-by-custom-id.md - https://docs.livelike.com/reference/create-quality-rules.md - https://docs.livelike.com/reference/create-quest-rewards.md - https://docs.livelike.com/reference/create-quests.md - https://docs.livelike.com/reference/create-reaction-emoji.md - https://docs.livelike.com/reference/create-reward-item.md - https://docs.livelike.com/reference/create-reward-table-entry.md - https://docs.livelike.com/reference/create-reward-table.md - https://docs.livelike.com/reference/create-role-assignments.md - https://docs.livelike.com/reference/create-role-grant-assignment.md - https://docs.livelike.com/reference/create-roles.md - https://docs.livelike.com/reference/create-task.md - https://docs.livelike.com/reference/create-text-poll.md - https://docs.livelike.com/reference/create-text-prediction-follow-up.md - https://docs.livelike.com/reference/create-text-prediction-option.md - https://docs.livelike.com/reference/create-tier-benefit.md - https://docs.livelike.com/reference/create-tier-group.md - https://docs.livelike.com/reference/create-tier.md - https://docs.livelike.com/reference/create-user-profile.md - https://docs.livelike.com/reference/create-user-quest.md - https://docs.livelike.com/reference/creating-reward-actions.md - https://docs.livelike.com/reference/credit-reward-item.md - https://docs.livelike.com/reference/debit-reward-item.md - https://docs.livelike.com/reference/delete-a-base-role.md - https://docs.livelike.com/reference/delete-a-comment.md - https://docs.livelike.com/reference/delete-a-flair-assignment.md - https://docs.livelike.com/reference/delete-a-flair.md - https://docs.livelike.com/reference/delete-a-program-ban.md - https://docs.livelike.com/reference/delete-a-redemption-key.md - https://docs.livelike.com/reference/delete-a-registered-link.md - https://docs.livelike.com/reference/delete-a-role.md - https://docs.livelike.com/reference/delete-a-tier-group.md - https://docs.livelike.com/reference/delete-a-user-reaction.md - https://docs.livelike.com/reference/delete-a-video-alert.md - https://docs.livelike.com/reference/delete-bulk-chat-memberships.md - https://docs.livelike.com/reference/delete-comment-board-by-custom-id.md - https://docs.livelike.com/reference/delete-comment-board.md - https://docs.livelike.com/reference/delete-comments-ban.md - https://docs.livelike.com/reference/delete-profile-group.md - https://docs.livelike.com/reference/delete-quest.md - https://docs.livelike.com/reference/delete-reaction-emoji.md - https://docs.livelike.com/reference/delete-reward-table-entry.md - https://docs.livelike.com/reference/delete-reward-table.md - https://docs.livelike.com/reference/delete-role-assignment.md - https://docs.livelike.com/reference/delete-role-grant-unassignment.md - https://docs.livelike.com/reference/delete-task.md - https://docs.livelike.com/reference/delete-tier-benefit.md - https://docs.livelike.com/reference/delete-tier.md - https://docs.livelike.com/reference/delete-userquest.md - https://docs.livelike.com/reference/delete-widget.md - https://docs.livelike.com/reference/dismiss-all-reports-for-a-reported-comment.md - https://docs.livelike.com/reference/flair-assignment-detail.md - https://docs.livelike.com/reference/flair-detail-1.md - https://docs.livelike.com/reference/flair-detail.md - https://docs.livelike.com/reference/get-a-badge.md - https://docs.livelike.com/reference/get-a-redemption-key.md - https://docs.livelike.com/reference/get-a-rich-post.md - https://docs.livelike.com/reference/get-a-social-embed.md - https://docs.livelike.com/reference/get-a-text-ask-widget.md - https://docs.livelike.com/reference/get-a-text-poll.md - https://docs.livelike.com/reference/get-a-text-quiz.md - https://docs.livelike.com/reference/get-a-video-alert.md - https://docs.livelike.com/reference/get-an-alert-1.md - https://docs.livelike.com/reference/get-an-asset-1.md - https://docs.livelike.com/reference/get-an-asset.md - https://docs.livelike.com/reference/get-an-emoji-slider.md - https://docs.livelike.com/reference/get-an-image-poll.md - https://docs.livelike.com/reference/get-an-image-quiz.md - https://docs.livelike.com/reference/get-blocked-profile-ids.md - https://docs.livelike.com/reference/get-blocked-profiles.md - https://docs.livelike.com/reference/get-chatroom-message-count.md - https://docs.livelike.com/reference/get-chatroom-messages.md - https://docs.livelike.com/reference/get-comment-board-by-custom_id.md - https://docs.livelike.com/reference/get-comment-counts.md - https://docs.livelike.com/reference/get-image-number-prediction.md - https://docs.livelike.com/reference/get-leaderboard-by-custom-id.md - https://docs.livelike.com/reference/get-list-of-base-roles.md - https://docs.livelike.com/reference/get-list-of-comment-board-bans.md - https://docs.livelike.com/reference/get-list-of-comment-reports.md - https://docs.livelike.com/reference/get-list-of-earned-badges.md - https://docs.livelike.com/reference/get-list-of-quest-rewards.md - https://docs.livelike.com/reference/get-list-of-resources.md - https://docs.livelike.com/reference/get-pinned-message-info.md - https://docs.livelike.com/reference/get-profile-by-custom-id.md - https://docs.livelike.com/reference/get-profile-group-detail.md - https://docs.livelike.com/reference/get-profile-group-members.md - https://docs.livelike.com/reference/get-program-bans.md - https://docs.livelike.com/reference/get-program-by-custom-id.md - https://docs.livelike.com/reference/get-quest-badges.md - https://docs.livelike.com/reference/get-quests.md - https://docs.livelike.com/reference/get-reaction-space-by-target-group-id.md - https://docs.livelike.com/reference/get-reported-chat-messages.md - https://docs.livelike.com/reference/get-reward-item-balance.md - https://docs.livelike.com/reference/get-reward-table-entry.md - https://docs.livelike.com/reference/get-reward-table.md - https://docs.livelike.com/reference/get-role-templates.md - https://docs.livelike.com/reference/get-roles.md - https://docs.livelike.com/reference/get-task.md - https://docs.livelike.com/reference/get-the-list-of-comment-boards.md - https://docs.livelike.com/reference/get-user-quest-rewards.md - https://docs.livelike.com/reference/get-user-reaction-count-per-space.md - https://docs.livelike.com/reference/get-user-reaction-count.md - https://docs.livelike.com/reference/get-users-badges.md - https://docs.livelike.com/reference/get_reaction-space-by-target-group-id-client-id-target-group-id-1.md - https://docs.livelike.com/reference/invoking-custom-actions.md - https://docs.livelike.com/reference/list-assets.md - https://docs.livelike.com/reference/list-available-badges.md - https://docs.livelike.com/reference/list-badge-progress.md - https://docs.livelike.com/reference/list-comments-by-author.md - https://docs.livelike.com/reference/list-comments.md - https://docs.livelike.com/reference/list-flair-assignments.md - https://docs.livelike.com/reference/list-flairs-1.md - https://docs.livelike.com/reference/list-flairs.md - https://docs.livelike.com/reference/list-invoked-reward-actions.md - https://docs.livelike.com/reference/list-permissions.md - https://docs.livelike.com/reference/list-pinned-comments.md - https://docs.livelike.com/reference/list-profile-relationships.md - https://docs.livelike.com/reference/list-profiles-who-have-earned-a-specific-badge.md - https://docs.livelike.com/reference/list-program-sponsors.md - https://docs.livelike.com/reference/list-quests.md - https://docs.livelike.com/reference/list-reaction-spaces.md - https://docs.livelike.com/reference/list-redemption-keys.md - https://docs.livelike.com/reference/list-registered-links.md - https://docs.livelike.com/reference/list-relationship-types.md - https://docs.livelike.com/reference/list-replies-to-profiles-comments.md - https://docs.livelike.com/reference/list-reward-actions.md - https://docs.livelike.com/reference/list-reward-item-balances.md - https://docs.livelike.com/reference/list-reward-item-transfers.md - https://docs.livelike.com/reference/list-reward-items.md - https://docs.livelike.com/reference/list-reward-tables.md - https://docs.livelike.com/reference/list-reward-transactions.md - https://docs.livelike.com/reference/list-rich-posts-1-1.md - https://docs.livelike.com/reference/list-rich-posts-1.md - https://docs.livelike.com/reference/list-rich-posts.md - https://docs.livelike.com/reference/list-role-assignments.md - https://docs.livelike.com/reference/list-tasks.md - https://docs.livelike.com/reference/list-tier-benefits.md - https://docs.livelike.com/reference/list-tier-groups.md - https://docs.livelike.com/reference/list-tier-transactions.md - https://docs.livelike.com/reference/list-tier.md - https://docs.livelike.com/reference/list-user-quests.md - https://docs.livelike.com/reference/list-user-reactions.md - https://docs.livelike.com/reference/list-user-tiers.md - https://docs.livelike.com/reference/list-widget-reports.md - https://docs.livelike.com/reference/moderate-a-widget-report.md - https://docs.livelike.com/reference/patch-update-a-base-role.md - https://docs.livelike.com/reference/patch-update-a-role-copy.md - https://docs.livelike.com/reference/patch_reaction-space-by-target-group-id-client-id-target-group-id-1-1.md - https://docs.livelike.com/reference/prizeout-user-session.md - https://docs.livelike.com/reference/profile-permissions-check.md - https://docs.livelike.com/reference/publish-widget.md - https://docs.livelike.com/reference/put-update-a-base-role.md - https://docs.livelike.com/reference/remove-a-chatroom-access-rule.md - https://docs.livelike.com/reference/remove-a-quest-reward.md - https://docs.livelike.com/reference/remove-badge-from-quest.md - https://docs.livelike.com/reference/remove-members-from-group.md - https://docs.livelike.com/reference/report-a-widget.md - https://docs.livelike.com/reference/retrieve-a-tier.md - https://docs.livelike.com/reference/retrieve-reward-item.md - https://docs.livelike.com/reference/retrieve-tier-benefit.md - https://docs.livelike.com/reference/revoke-earned-badge.md - https://docs.livelike.com/reference/reward-item-transfers.md - https://docs.livelike.com/reference/role-grant-detail.md - https://docs.livelike.com/reference/role-grants-list.md - https://docs.livelike.com/reference/send-a-widget-chat-message.md - https://docs.livelike.com/reference/send-chat-message.md - https://docs.livelike.com/reference/unassignment-by-natural-key.md - https://docs.livelike.com/reference/unblock-profile-by-profile-custom-id.md - https://docs.livelike.com/reference/unblock-profile.md - https://docs.livelike.com/reference/unpin-a-pinned-comment.md - https://docs.livelike.com/reference/unpin-message.md - https://docs.livelike.com/reference/update-a-comment-board.md - https://docs.livelike.com/reference/update-a-comment.md - https://docs.livelike.com/reference/update-a-flair-1.md - https://docs.livelike.com/reference/update-a-flair-assignment.md - https://docs.livelike.com/reference/update-a-flair.md - https://docs.livelike.com/reference/update-a-redemption-key-by-code.md - https://docs.livelike.com/reference/update-a-redemption-key.md - https://docs.livelike.com/reference/update-a-role.md - https://docs.livelike.com/reference/update-a-video-alert.md - https://docs.livelike.com/reference/update-comment-board-by-custom-id.md - https://docs.livelike.com/reference/update-comment-quality-rules.md - https://docs.livelike.com/reference/update-image-number-prediction-option.md - https://docs.livelike.com/reference/update-image-number-prediction.md - https://docs.livelike.com/reference/update-image-prediction-option.md - https://docs.livelike.com/reference/update-profile-group.md - https://docs.livelike.com/reference/update-reaction-emoji.md - https://docs.livelike.com/reference/update-text-prediction-option.md - https://docs.livelike.com/reference/update-tier-benefit.md - https://docs.livelike.com/reference/update-tier-group.md - https://docs.livelike.com/reference/update-tier.md - https://docs.livelike.com/reference/update-user-quest-task-progress.md - https://docs.livelike.com/reference/update-user-quest.md merge: pages: 237 deduped: 0 conflicts_kept_first: 0