action braze_list_user_s_subscription_group_status_sms { label: "List User's Subscription Group Status - SMS" description: "Use the endpoint below to get the subscription state of a user in a subscription group. The response from this endpoint will include the external ID and either subscribed, unsubscribed, or unknown for the specific subscription group requested in the API call. This can be used to update the subscription group state in subsequent API calls or to be displayed on a hosted web page.\n\n> *Either `external_id` or `email` are required.\n\n## Response\n\nAll successful responses will return `subscribed`, `unsubscribed`, or `unknown` depending on status and user history with the subscription group.\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n \"status\": {\n \"1\": \"Unsubscribed\",\n \"2\": \"Subscribed\"\n },\n \"message\": \"success\"\n}\n```" provider: braze method: GET path: "/subscription/status/get" encoding: json input: { type: "object" properties: { external_id: { type: "string" } phone: { type: "string" } subscription_group_id: { type: "string" } } additionalProperties: false } output: { type: "object" additionalProperties: true } }