Recipient API Data Sync

📍 To access the Recipient API, go to: More > Integrations > Recipient API

Overview

RedFlag supports syncing recipient data directly through an API connection. This enables you to securely and programmatically update recipient profiles in your RedFlag database without manual imports. The RedFlag Recipient API allows you to:

• Add or update recipient records
• Sync data fields such as name, email, mobile number, and custom attributes
• Automatically group recipients based on shared data attributes
• Maintain a real-time connection between your source system and RedFlag

🛡️ Note: This API is intended for programmatic use and should be accessed by your IT or development team.

API Documentation

Visit the API documentation to review available endpoints, required headers, and example payloads. You will find:

• Authentication setup
• Recipient POST and PATCH examples
• Field definitions and expected formats
• Error codes and handling

Documentation: https://recipient-api.redflagapp.net/index.html

API Access Credentials

To use the Recipient API, your RedFlag location must be enabled for API access.

• Navigate to More > Integrations > Recipient API.
• Copy the Bearer Token.
• Click “Documentation”.
• Click “Authorize”.
• Paste the Bearer Token into the value box and click “Authorize”.

🛡️ Note: Only data fields enabled in Profile Data Field Setup can be updated via the API. Navigate to More > Setup > Profile Data Field Setup to manage field availability.

Build and Test Your Integration

Using the API documentation, your development team should:

• Authenticate your request using the provided API key in the Authorization header.
• Format your payload based on the JSON structure outlined in the docs.
• Use the POST endpoint to add new recipients or the PATCH endpoint to update existing ones.
• Test your payloads using a staging or test RedFlag location before pushing to production.

🛡️ Note: Each recipient must include a unique identifier (such as recipient_id, email, or mobile_number) depending on your setup.

Monitor Sync Status

After submitting data through the API:

• Check for 200 or 201 status codes indicating success
• Review error responses (400, 403, etc.) to identify any payload or authorization issues
• Confirm recipients are visible under Recipients > View Recipients

Troubleshooting

If you experience issues:

• Verify your API key and Location ID are correctly entered
• Ensure you’re sending data to the correct URL and endpoint
• Confirm required fields are included in the payload
• Check that data fields are enabled in RedFlag
• Review the error message returned in the API response