{ "opencollection": "1.0.0", "info": { "name": "MagicBell apns user API", "version": "2.0.0" }, "items": [ { "info": { "name": "user", "type": "folder" }, "items": [ { "info": { "name": "get_mobile_push_apns_tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/mobile_push/apns/tokens", "params": [ { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[after]", "value": "", "type": "query" }, { "name": "page[before]", "value": "", "type": "query" } ] }, "docs": "Lists all mobile_push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata." }, { "info": { "name": "save_mobile_push_apns_token", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/channels/mobile_push/apns/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Saves a mobile_push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel." }, { "info": { "name": "get_mobile_push_apns_token", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/mobile_push/apns/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details of a specific mobile_push token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens." }, { "info": { "name": "discard_mobile_push_apns_token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/channels/mobile_push/apns/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Revokes one of the authenticated user's mobile_push tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens." }, { "info": { "name": "get_mobile_push_expo_tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/mobile_push/expo/tokens", "params": [ { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[after]", "value": "", "type": "query" }, { "name": "page[before]", "value": "", "type": "query" } ] }, "docs": "Lists all mobile_push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata." }, { "info": { "name": "save_mobile_push_expo_token", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/channels/mobile_push/expo/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Saves a mobile_push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel." }, { "info": { "name": "get_mobile_push_expo_token", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/mobile_push/expo/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details of a specific mobile_push token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens." }, { "info": { "name": "discard_mobile_push_expo_token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/channels/mobile_push/expo/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Revokes one of the authenticated user's mobile_push tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens." }, { "info": { "name": "get_mobile_push_fcm_tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/mobile_push/fcm/tokens", "params": [ { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[after]", "value": "", "type": "query" }, { "name": "page[before]", "value": "", "type": "query" } ] }, "docs": "Lists all mobile_push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata." }, { "info": { "name": "save_mobile_push_fcm_token", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/channels/mobile_push/fcm/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Saves a mobile_push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel." }, { "info": { "name": "get_mobile_push_fcm_token", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/mobile_push/fcm/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details of a specific mobile_push token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens." }, { "info": { "name": "discard_mobile_push_fcm_token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/channels/mobile_push/fcm/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Revokes one of the authenticated user's mobile_push tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens." }, { "info": { "name": "get_slack_tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/slack/tokens", "params": [ { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[after]", "value": "", "type": "query" }, { "name": "page[before]", "value": "", "type": "query" } ] }, "docs": "Lists all slack tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata." }, { "info": { "name": "save_slack_token", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/channels/slack/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Saves a slack token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel." }, { "info": { "name": "get_slack_token", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/slack/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details of a specific slack token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens." }, { "info": { "name": "discard_slack_token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/channels/slack/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Revokes one of the authenticated user's slack tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens." }, { "info": { "name": "get_teams_tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/teams/tokens", "params": [ { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[after]", "value": "", "type": "query" }, { "name": "page[before]", "value": "", "type": "query" } ] }, "docs": "Lists all teams tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata." }, { "info": { "name": "save_teams_token", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/channels/teams/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Saves a teams token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel." }, { "info": { "name": "get_teams_token", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/teams/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details of a specific teams token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens." }, { "info": { "name": "discard_teams_token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/channels/teams/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Revokes one of the authenticated user's teams tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens." }, { "info": { "name": "get_web_push_tokens", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/web_push/tokens", "params": [ { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[after]", "value": "", "type": "query" }, { "name": "page[before]", "value": "", "type": "query" } ] }, "docs": "Lists all web_push tokens belonging to the authenticated user. Returns a paginated list of tokens, including their status, creation dates, and associated metadata." }, { "info": { "name": "save_web_push_token", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/channels/web_push/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Saves a web_push token for the authenticated user. This token serves as a credential for accessing channel-specific functionality. Each token is unique to the user and channel combination, allowing for direct communication with the user via the channel." }, { "info": { "name": "get_web_push_token", "type": "http" }, "http": { "method": "GET", "url": "https://api.magicbell.com/v2/channels/web_push/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Retrieves details of a specific web_push token belonging to the authenticated user. Returns information about the token's status, creation date, and any associated metadata. Users can only access their own tokens." }, { "info": { "name": "discard_web_push_token", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.magicbell.com/v2/channels/web_push/tokens/:token_id", "params": [ { "name": "token_id", "value": "", "type": "path" } ] }, "docs": "Revokes one of the authenticated user's web_push tokens. This permanently invalidates the specified token, preventing it from being used for future channel access. This action cannot be undone. Users can only revoke their own tokens." }, { "info": { "name": "save_inbox_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/inbox/installations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new installation of a inbox integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration." }, { "info": { "name": "start_inbox_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/inbox/installations/start" }, "docs": "Initiates the installation flow for a inbox integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required." }, { "info": { "name": "save_slack_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/slack/installations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new installation of a slack integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration." }, { "info": { "name": "finish_slack_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/slack/installations/finish", "body": { "type": "json", "data": "{}" } }, "docs": "Completes the installation flow for a slack integration. This endpoint is typically called after the user has completed any required authorization steps with slack." }, { "info": { "name": "start_slack_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/slack/installations/start", "body": { "type": "json", "data": "{}" } }, "docs": "Initiates the installation flow for a slack integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required." }, { "info": { "name": "save_templates_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/templates/installations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new installation of a templates integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration." }, { "info": { "name": "save_web_push_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/web_push/installations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new installation of a web_push integration for a user. This endpoint is used when an integration needs to be set up with user-specific credentials or configuration." }, { "info": { "name": "start_web_push_installation", "type": "http" }, "http": { "method": "POST", "url": "https://api.magicbell.com/v2/integrations/web_push/installations/start" }, "docs": "Initiates the installation flow for a web_push integration. This is the first step in a multi-step installation process where user authorization or external service configuration may be required." } ] } ], "bundled": true }