# Nudgescribe API Reference

## Docs
- [Nudgescribe API](https://api-docs.nudgescribe.com/nudgescribe-api-1319501m0.md): 
- Authentication [Authentication](https://api-docs.nudgescribe.com/authentication-1320397m0.md): 
- Content > Customers [Customer Management](https://api-docs.nudgescribe.com/customer-management-1579676m0.md): 
- Content > Customer Groups [Customer Groups](https://api-docs.nudgescribe.com/customer-groups-1580277m0.md): 
- Content > Customer Profile Fields [Customer Profile Fields](https://api-docs.nudgescribe.com/customer-profile-fields-1536805m0.md): 
- Campaigns [Campaigns and Campaign Messages](https://api-docs.nudgescribe.com/campaigns-and-campaign-messages-1704560m0.md): 

## API Docs
- Authentication [Authenticate](https://api-docs.nudgescribe.com/authenticate-21253286e0.md): Primary authentication endpoint for client applications and third-party integrations requiring programmatic access to the NudgeScribe platform.
- Authentication [Re-Authenticate](https://api-docs.nudgescribe.com/re-authenticate-21297244e0.md): Re-authentication endpoint for refreshing expired tokens or validating existing authentication status for client applications.
- Content > Customers [Upload and Validate Customer Data](https://api-docs.nudgescribe.com/upload-and-validate-customer-data-21254956e0.md): Comprehensive validation endpoint that verifies both CSV headers and customer data against your workspace's field configuration before upload. This ensures data quality and prevents upload failures.
- Content > Customers [Get pages](https://api-docs.nudgescribe.com/get-pages-21395356e0.md): Returns the total number of pages available for a customer group, enabling efficient pagination when retrieving large customer datasets.
- Content > Customers [Get Customers](https://api-docs.nudgescribe.com/get-customers-21254995e0.md): Retrieves customer records from a specific customer group with pagination support, returning encrypted profile data that can be decrypted as needed.
- Content > Customers [Update Customers](https://api-docs.nudgescribe.com/update-customers-21255000e0.md): Updates existing customer records by matching unique identifiers, with support for both bulk CSV updates and individual customer modifications.
- Content > Customers [Delete Customers](https://api-docs.nudgescribe.com/delete-customers-21255025e0.md): Permanently removes customer records from your workspace, supporting both individual and bulk deletion operations with comprehensive audit logging.
- Content > Customer Groups [Create Customer Group](https://api-docs.nudgescribe.com/create-customer-group-21262431e0.md): Creates a new customer group within your workspace, enabling you to organize customers into logical segments for targeted campaigns, analytics, and data management.
- Content > Customer Groups [Get Customer Groups](https://api-docs.nudgescribe.com/get-customer-groups-21262453e0.md): Retrieves all customer groups within your workspace, providing complete information about your customer segmentation structure.
- Content > Customer Groups [Update Customer Group](https://api-docs.nudgescribe.com/update-customer-group-21262457e0.md): Updates the name and properties of an existing customer group while preserving all customer assignments and historical data associated with the group.
- Content > Customer Groups [Delete Customer Group](https://api-docs.nudgescribe.com/delete-customer-group-21262461e0.md): Permanently removes a customer group from your workspace. This operation should be used carefully as it may affect customer organization and reporting capabilities.
- Content > Customer Profile Fields [Create a Custom Profile Field](https://api-docs.nudgescribe.com/create-a-custom-profile-field-21165314e0.md): Creates a new custom field for collecting customer profile data within your workspace. This endpoint allows you to define dynamic fields that match your specific customer data collection needs.
- Content > Customer Profile Fields [Get Customer Profile Fields for a Workspace](https://api-docs.nudgescribe.com/get-customer-profile-fields-for-a-workspace-21165323e0.md): Retrieves all custom fields configured for your workspace, including their definitions, validation rules, and available options for enum fields.
- Content > Customer Profile Fields [Update Custom Fields](https://api-docs.nudgescribe.com/update-custom-fields-21165325e0.md): Updates existing custom field properties such as display names, required status, and validation rules while preserving existing customer data.
- Content > Customer Profile Fields [Delete Custom Fields](https://api-docs.nudgescribe.com/delete-custom-fields-21165328e0.md): Permanently removes custom fields from your workspace, including all associated customer data stored in those fields.
- Campaigns [Get All Accounts Campaigns](https://api-docs.nudgescribe.com/get-all-accounts-campaigns-23496088e0.md): 
- Campaigns [Publish Messages to Secure Storage](https://api-docs.nudgescribe.com/publish-messages-to-secure-storage-23415434e0.md): Exports generated campaign messages to secure cloud storage in CSV format, making them accessible for download and integration with external systems. Enables secure, scalable access to generated messages for campaign execution, analytics, and integration with delivery platforms.
- Campaigns [Retrieve Published Messages](https://api-docs.nudgescribe.com/retrieve-published-messages-23415624e0.md): Retrieves campaign message files in various formats including, raw UTF-8 CSV, parsed JSON, or secure download URLs.
- Campaigns [Get Campaign Messages Pages](https://api-docs.nudgescribe.com/get-campaign-messages-pages-23505469e0.md): Returns the number of message files available for a campaign, enabling pagination when retrieving large message datasets.