v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Create Profile by Custom ID

Create a new user profile with a custom ID

post/profile-by-custom-id/{client_id}/{custom_id}/

Path parameters

client_idstring required

The client ID of the application the profile was created in

custom_idstring required

The custom ID to be associated with the profile

Request body

nicknamestring

If not provided, a randomized nickname will be assigned

custom_datastring

String data to send with the user profile. Typically contains a string JSON payload to be decoded by the client SDK

Response

201

created_atstring

client_idstring

redemption_keys_urlstring

custom_idstring

urlstring

leaderboards_urlstring

leaderboard_views_urlstring

access_tokenstring

reward_item_balances_urlstring

blocked_profile_ids_urlstring

reward_item_credit_urlstring

nicknamestring

reward_item_debit_urlstring

block_profile_urlstring

reward_item_transfer_urlstring

badge_progress_urlstring

{"stackTrail":"paths:/profile-by-custom-id/{client_id}/{custom_id}/:post:responses:201:content:application/json:schema:properties:custom_data","oasType":"schema","type":"unknown"}

badges_urlstring

pointsinteger

reported_countinteger

subscribe_channelstring

idstring

chat_room_memberships_urlstring

chat_room_invitations_url_templatestring

blocked_profiles_template_urlstring

Example response

{
  "created_at": "2025-01-23T10:14:06+0000",
  "client_id": "mOBYul18quffrBDuq2IACKtVuLbUzXIPye5S3bq5",
  "redemption_keys_url": "https://cf-blast.livelikecdn.com/api/v1/redemption-keys/",
  "custom_id": "012345",
  "url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/",
  "leaderboards_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/leaderboards/",
  "leaderboard_views_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/leaderboard-views/",
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGllbnRfaWQiOiJtT0JZdWwxOHF1ZmZyQkR1cTJJQUNLdFZ1TGJVelhJUHllNVMzYnE1IiwiaWF0IjoxNzM3NjI3MjQ2LCJpZCI6ImY4YWViOGNlLTc3NTctNDZiMi1hMWE4LWE2YWU3OTQ2YzFlYiIsImFjY2Vzc190b2tlbiI6IjkxZThhYjVhNTEyMjVhOWNhZjk1NGU4MzE4YTMyNzkzNjE4MGM0OTQiLCJpc3MiOiJibGFzdHJ0In0.8WsYdQ0MrCSjhRTuT_tZLkh4S9z8_iYJ0hDh8ywkY3Q",
  "reward_item_balances_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/reward-item-balances/",
  "blocked_profile_ids_url": "https://cf-blast.livelikecdn.com/api/v1/blocked-profile-ids/",
  "reward_item_credit_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/reward-item-credits/",
  "nickname": "test",
  "reward_item_debit_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/reward-item-debits/",
  "block_profile_url": "https://cf-blast.livelikecdn.com/api/v1/profile-blocks/",
  "reward_item_transfer_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/reward-item-transfers/",
  "badge_progress_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/badge-progress/",
  "badges_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/badges/",
  "subscribe_channel": "profile.f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb",
  "id": "f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb",
  "chat_room_memberships_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/f8aeb8ce-7757-46b2-a1a8-a6ae7946c1eb/chat-room-memberships/",
  "chat_room_invitations_url_template": "https://cf-blast.livelikecdn.com/api/v1/chat-room-invitations/?client_id={client_id}&invited_profile_id={profile_id}",
  "blocked_profiles_template_url": "https://cf-blast.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id}"
}