v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Create a Program Ban

post/api/v1/program-bans/

Request body

banned_profile_idstring required

profile id of the user being banned

commentstring

any comments by the banner/moderator

program_idstring required

Id of the program bannee needs to be banned from

expiring_atstring date

Optional Expiry Date for the ban

Response

201

idstring

urlstring

client_idstring

program_idstring

created_atstring

{"stackTrail":"paths:/api/v1/program-bans/:post:responses:201:content:application/json:schema:properties:expiring_at","oasType":"schema","type":"unknown"}

commentstring

Example response

{
  "id": "3072633b-c526-4d38-a325-3ec5d88056dd",
  "url": "https://cf-blast-dig.livelikecdn.com/api/v1/program-bans/3072633b-c526-4d38-a325-3ec5d88056dd/",
  "client_id": "lom9db0XtQUhOZQq1vz8QPfSpiyyxppiUVGMcAje",
  "program_id": "798e1ea8-2b61-42b9-a604-425720c735a9",
  "banned_profile": {
    "id": "a8ecfafb-f3d8-4522-8a61-8702ece1fd30",
    "url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/",
    "created_at": "2024-04-04T10:23:00Z",
    "nickname": "Atomic Winner",
    "badges_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/badges/",
    "badge_progress_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/badge-progress/",
    "subscribe_channel": "profile.a8ecfafb-f3d8-4522-8a61-8702ece1fd30",
    "chat_room_memberships_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/chat-room-memberships/",
    "reward_item_credit_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/reward-item-credits/",
    "reward_item_debit_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/reward-item-debits/",
    "reward_item_balances_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/reward-item-balances/",
    "reward_item_transfer_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/reward-item-transfers/",
    "block_profile_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profile-blocks/",
    "blocked_profiles_template_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id}",
    "blocked_profile_ids_url": "https://cf-blast-dig.livelikecdn.com/api/v1/blocked-profile-ids/",
    "leaderboards_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/leaderboards/",
    "leaderboard_views_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/leaderboard-views/",
    "earned_badges_url": "https://cf-blast-dig.livelikecdn.com/api/v1/earned-badges/?profile_id=a8ecfafb-f3d8-4522-8a61-8702ece1fd30",
    "redemption_keys_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/a8ecfafb-f3d8-4522-8a61-8702ece1fd30/redemption-keys/"
  },
  "banned_by_profile": {
    "id": "addc8959-c87e-4b28-b0cf-35643884d848",
    "url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/",
    "created_at": "2024-04-04T10:23:00Z",
    "nickname": "Cool Dino",
    "badges_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/badges/",
    "badge_progress_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/badge-progress/",
    "subscribe_channel": "profile.addc8959-c87e-4b28-b0cf-35643884d848",
    "chat_room_memberships_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/chat-room-memberships/",
    "reward_item_credit_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/reward-item-credits/",
    "reward_item_debit_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/reward-item-debits/",
    "reward_item_balances_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/reward-item-balances/",
    "reward_item_transfer_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/reward-item-transfers/",
    "block_profile_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profile-blocks/",
    "blocked_profiles_template_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id}",
    "blocked_profile_ids_url": "https://cf-blast-dig.livelikecdn.com/api/v1/blocked-profile-ids/",
    "leaderboards_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/leaderboards/",
    "leaderboard_views_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/leaderboard-views/",
    "earned_badges_url": "https://cf-blast-dig.livelikecdn.com/api/v1/earned-badges/?profile_id=addc8959-c87e-4b28-b0cf-35643884d848",
    "redemption_keys_url": "https://cf-blast-dig.livelikecdn.com/api/v1/profiles/addc8959-c87e-4b28-b0cf-35643884d848/redemption-keys/"
  },
  "created_at": "2024-04-12T11:13:29.987086Z",
  "comment": "test comment123"
}