### Pagination Example Source: https://mailchimp.com/developer/marketing/docs/methods-parameters Demonstrates how to use 'offset' and 'count' query parameters to paginate API requests for the campaigns resource. ```APIDOC ## GET /3.0/campaigns ### Description Retrieves a paginated list of campaigns, allowing control over the number of results and the starting offset. ### Method GET ### Endpoint https://usX.api.mailchimp.com/3.0/campaigns ### Parameters #### Query Parameters - **offset** (integer) - Optional - The number of results to skip before starting to return results. Defaults to 0. - **count** (integer) - Optional - The number of results to return. Maximum value is 1000. Defaults to 10. ### Request Example ``` https://usX.api.mailchimp.com/3.0/campaigns?offset=0&count=10 ``` ### Response #### Success Response (200) - **campaigns** (array) - A list of campaign objects. - **total_items** (integer) - The total number of campaigns available. #### Response Example (Response structure will vary based on the actual campaign data) ``` -------------------------------- ### Partial Response Example (Fields) Source: https://mailchimp.com/developer/marketing/docs/methods-parameters Illustrates using the 'fields' query parameter to retrieve only specific fields from the lists resource. ```APIDOC ## GET /3.0/lists ### Description Retrieves a list of audiences (lists), returning only the specified fields to reduce response size. ### Method GET ### Endpoint https://usX.api.mailchimp.com/3.0/lists ### Parameters #### Query Parameters - **fields** (string) - Optional - A comma-separated list of fields to include in the response. Nested fields are referenced by dot notation. ### Request Example ``` https://usX.api.mailchimp.com/3.0/lists?fields=lists.name,lists.id ``` ### Response #### Success Response (200) - **lists** (array) - A list of list objects, each containing 'name' and 'id' fields. #### Response Example ```json { "lists": [ { "name": "My First List", "id": "abcdef1234" }, { "name": "Second List", "id": "ghijkl5678" } ] } ``` ``` -------------------------------- ### Configure Android Repositories and Dependencies Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk To install the Mailchimp Mobile SDK for Android, ensure the Jitpack repository is listed and add the SDK dependency to your build.gradle file. ```gradle repositories { // any other repositories maven { url 'https://jitpack.io' } } dependencies { implementation 'com.github.mailchimp:Mailchimp-SDK-Android:1.0.0' } ``` -------------------------------- ### Partial Response Example (Exclude Fields) Source: https://mailchimp.com/developer/marketing/docs/methods-parameters Demonstrates using the 'exclude_fields' query parameter to omit specific fields from the response for the lists resource. ```APIDOC ## GET /3.0/lists ### Description Retrieves a list of audiences (lists), excluding specified fields to reduce response size. ### Method GET ### Endpoint https://usX.api.mailchimp.com/3.0/lists ### Parameters #### Query Parameters - **exclude_fields** (string) - Optional - A comma-separated list of fields to exclude from the response. Nested fields are referenced by dot notation. ### Request Example ``` https://usX.api.mailchimp.com/3.0/lists?exclude_fields=lists.name ``` ### Response #### Success Response (200) - **lists** (array) - A list of list objects, excluding the 'name' field. #### Response Example ```json { "lists": [ { "id": "abcdef1234" }, { "id": "ghijkl5678" } ] } ``` ``` -------------------------------- ### Specific Resource Field Example Source: https://mailchimp.com/developer/marketing/docs/methods-parameters Shows how to retrieve a specific field ('name') for a single list resource using the 'fields' parameter. ```APIDOC ## GET /3.0/lists/{list_id} ### Description Retrieves a specific audience (list) by its ID, returning only the 'name' field. ### Method GET ### Endpoint https://usX.api.mailchimp.com/3.0/lists/{list_id} ### Parameters #### Path Parameters - **list_id** (string) - Required - The unique ID of the list. #### Query Parameters - **fields** (string) - Optional - A comma-separated list of fields to include in the response. For this endpoint, use 'name' to get the audience name. ### Request Example ``` https://usX.api.mailchimp.com/3.0/lists/{list_id}?fields=name ``` ### Response #### Success Response (200) - **name** (string) - The name of the audience (list). #### Response Example ```json { "name": "My Specific List" } ``` ``` -------------------------------- ### Initialize the Mobile SDK for Android Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk Initialize the Mailchimp SDK when your Android app starts. Configure the SDK key, debug mode, and auto-tagging. Auto-tagging is enabled by default. ```kotlin val sdkKey = "YOUR_API_KEY" val isDebugBuild = BuildConfig.DEBUG val configuration = MailchimpSdkConfiguration.Builder(context, sdkKey) .isDebugModeEnabled(isDebugBuild) .isAutoTaggingEnabled(true) .build() val mailchimpSdk = Mailchimp.initialize(configuration) // creates a new shared instance that can be accessed by calling Mailchimp.sharedInstance() ``` -------------------------------- ### Add a contact with merge data Source: https://mailchimp.com/developer/marketing/docs/merge-fields This example demonstrates how to add a new contact to a Mailchimp list and populate their merge fields, such as first name, last name, and birthday. It also shows how to include complex merge field types like 'ADDRESS'. ```APIDOC ## POST /lists/{list_id}/members?skip_merge_validation=false ### Description Adds a new contact to a specified Mailchimp list, allowing for the population of merge fields. ### Method POST ### Endpoint `/lists/{list_id}/members` ### Query Parameters - **skip_merge_validation** (boolean) - Optional - If set to `true`, bypasses the requirement for all merge fields marked as `required`. ### Request Body - **email_address** (string) - Required - The email address of the contact. - **status** (string) - Required - The subscription status of the contact (e.g., "pending", "subscribed"). - **merge_fields** (object) - Optional - An object containing key-value pairs for merge fields. The key is the merge field tag, and the value depends on the merge field type (string, number, object, etc.). - **FNAME** (string) - First name of the contact. - **LNAME** (string) - Last name of the contact. - **BIRTHDAY** (string) - Birthday of the contact in `MM/DD` format. - **ADDRESS** (object) - Address details for the contact. - **addr1** (string) - Required - Street address. - **city** (string) - Required - City. - **state** (string) - Required - State or province. - **zip** (string) - Required - ZIP or postal code. - **addr2** (string) - Optional - Second street address line. - **country** (string) - Optional - Country. ### Request Example ```json { "email_address": "Elinore.Grady9@gmail.com", "status": "pending", "merge_fields": { "FNAME": "Elinore", "LNAME": "Grady", "BIRTHDAY": "01/22", "ADDRESS": { "addr1": "123 Freddie Ave", "city": "Atlanta", "state": "GA", "zip": "12345" } } } ``` ### Response #### Success Response (200) - **id** (string) - The unique ID of the created contact. #### Response Example ```json { "id": "a1b2c3d4e5f678901234567890abcdef" } ``` ### Error Handling #### Required merge field error (400) If a required merge field is omitted, an error response will be returned. ### Error Response Example ```json { "title":"Invalid Resource", "status":400, "detail":"Your merge fields were invalid.", "errors":[ { "field":"RADIO", "message":"Please enter a value" } ] } ``` ``` -------------------------------- ### Get Job Status by ID Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk Retrieve the current status of a job using its unique identifier. This is useful for polling job completion. ```kotlin val uuid = sdk.addTag("example@user.com", "ExampleTag") val status = sdk.getStatusById(uuid) //... if (status == WorkStatus.FINISHED) { Log.i("Mailchimp SDK", "Tag Was Added") } ``` -------------------------------- ### Mailchimp Marketing API HTTP Methods Source: https://mailchimp.com/developer/marketing/docs/methods-parameters The Mailchimp Marketing API supports standard HTTP methods for interacting with resources. This includes GET for retrieval, POST for creation, PATCH for partial updates, PUT for creation or full updates, and DELETE for removal. For endpoints that deviate from traditional REST conventions, actions are often namespaced under '/actions' in the URI. ```APIDOC ## Mailchimp Marketing API HTTP Methods Overview ### Description This section details the standard HTTP methods supported by the Mailchimp Marketing API and their general usage. ### HTTP Methods Supported - **GET**: Retrieve data. Safe and idempotent, does not change data. - **POST**: Create new resources. Typically used with collection endpoints, providing all required information in the request body. - **PATCH**: Update a resource. Only requires the data that needs to be changed. - **PUT**: Create or update a resource. Useful for syncing contact data. - **DELETE**: Remove a resource. ### Special Actions Some endpoints use a non-standard REST approach, namespacing verbs under `/actions` in the URI. Example: `POST /automations/{workflow_id}/emails/{id}/actions/pause`. ### X-HTTP-Method-Override Header For firewalls that do not support methods like PATCH or DELETE, use the `X-HTTP-Method-Override` header with a POST request. The value of the header should be the desired HTTP method (e.g., `X-HTTP-Method-Override: PATCH`). This override only works with POST requests. ### Request Body Parameters For POST, PATCH, and PUT requests, a JSON-formatted request body may be required. The API reference provides details on available parameters and required fields for each endpoint. ### Response Body Parameters API call responses include headers and an optional JSON-formatted body. DELETE requests return only headers. Some responses, like 204 No Content, do not include a JSON body. The API reference details the specific response for each API call. ``` -------------------------------- ### JSON Error Response Example Source: https://mailchimp.com/developer/marketing/docs/errors This snippet illustrates the JSON format of an API error response. It includes a type, title, status code, detail message, and a unique instance identifier for the error. ```json { "type": "https://mailchimp.com/developer/marketing/docs/errors/", "title": "Method Not Allowed", "status": 405, "detail": "The requested method and resource are not compatible. See the Allow header for this resource's available methods.", "instance": "3b4dcb40-0b6b-4820-bfaa-41267b3826ea" } ``` -------------------------------- ### Get Job Status by ID (LiveData) Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk Provides LiveData that can be observed to monitor the state of a job in real-time. This is ideal for UI-related updates where you need to react to status changes. ```APIDOC ## getStatusByIdLiveData() ### Description Returns a LiveData object that emits the current status of a job. This allows for reactive updates to the UI or other components. ### Method Signature `getStatusByIdLiveData(uuid: String): LiveData` ### Parameters * **uuid** (String) - Required - The unique identifier of the job. ### Return Value * **LiveData** - A LiveData object that updates with the job's status. ### Example ```kotlin val uuid = sdk.addTag("example@user.com", "ExampleTag") val statusLiveData = sdk.getStatusByIdLiveData(uuid) statusLiveData.observe( this, Observer { Toast.makeText(this, "Current Job Status: $it", Toast.LENGTH_SHORT).show() } ) ``` ``` -------------------------------- ### Filtering with Fields Parameter for Specific Endpoint Source: https://mailchimp.com/developer/marketing/docs/methods-parameters When requesting a specific resource, the field name may be at the top level. This example shows how to retrieve just the 'name' field for a specific audience. ```url https://usX.api.mailchimp.com/3.0/lists/{list_id}?fields=name ``` -------------------------------- ### Filtering with Fields Parameter Source: https://mailchimp.com/developer/marketing/docs/methods-parameters Use the 'fields' query string parameter to limit the response to specific fields. Fields are referenced by dot notation for nested fields. This example requests only the audience name and ID. ```url https://usX.api.mailchimp.com/3.0/lists?fields=lists.name,lists.id ``` -------------------------------- ### Authenticate with Basic HTTP Authentication Source: https://mailchimp.com/developer/marketing/docs/fundamentals Use this method for authenticating API requests with an API key or OAuth 2.0 token via HTTP Basic Authentication. Replace `` with your data center and `` with your actual token. ```bash curl --request GET \ --url 'https://.api.mailchimp.com/3.0/' \ --user 'anystring:TOKEN' ``` -------------------------------- ### Build an Address Object Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk Construct an Address object for a contact. Required fields are address line one, city, and zip code. Optional fields include address line two, state, and country. ```kotlin val address = Address.Builder("123 Chimp St.", “Atlanta”, "30308") .setAddressLineTwo("Suite 456") .setState("GA") .setCountry(Country.USA) .build() ``` -------------------------------- ### Authenticate with Bearer Authentication Source: https://mailchimp.com/developer/marketing/docs/fundamentals Use this method for authenticating API requests with an API key or OAuth 2.0 token via Bearer Authentication. Replace `` with your data center and `` with your actual token. ```bash --url 'https://.api.mailchimp.com/3.0/' \ --header "Authorization: Bearer " ``` -------------------------------- ### Add GDPR Permissions to a Contact Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk Set GDPR marketing permissions for a contact by providing the audience-specific key and a boolean value indicating consent. This is crucial for GDPR-compliant audiences. ```kotlin val emailPermissionKey = "YOUR_AUDIENCE_EMAIL_KEY" val mailPermissionKey = "YOUR_AUDIENCE_MAIL_KEY" val advertisingPermissionKey = "YOUR_AUDIENCE_ADVERTISING_KEY" val newContact = Contact.Builder("example@email.com") .setMarketingPermission(emailPermissionKey, true) .setMarketingPermission(mailPermissionKey, true) .setMarketingPermission(advertisingPermissionKey, true) .build() val sdk = Mailchimp.sharedInstance() sdk.createOrUpdateContact(newContact) ``` -------------------------------- ### Download Previous Account Exports Source: https://mailchimp.com/developer/marketing/docs/account-exports Retrieve a list of all previously completed account exports within the last 90 days. Each item in the response includes a `download_url` to access the exported data. ```APIDOC ## GET /3.0/account-exports ### Description Retrieves a list of all previously completed account exports from the last 90 days. ### Method GET ### Endpoint `https://${dc}.api.mailchimp.com/3.0/account-exports` ### Response #### Success Response (200) - **exports** (array of objects) - A list of completed exports. - **id** (string) - The unique identifier for the export job. - **status** (string) - The status of the export job (should be `complete`). - **created_at** (string) - The timestamp when the export was requested. - **completed_at** (string) - The timestamp when the export was completed. - **download_url** (string) - The URL to download the exported data. #### Response Example ```json { "exports": [ { "id": "a1b2c3d4e5f678901234567890abcdef", "status": "complete", "created_at": "2023-10-26T12:00:00+00:00", "completed_at": "2023-10-26T13:00:00+00:00", "download_url": "https://storage.googleapis.com/mailchimp-exports/your-account/export-12345.zip" }, { "id": "b2c3d4e5f678901234567890abcdefa1", "status": "complete", "created_at": "2023-10-25T09:00:00+00:00", "completed_at": "2023-10-25T10:00:00+00:00", "download_url": "https://storage.googleapis.com/mailchimp-exports/your-account/export-67890.zip" } ] } ``` ``` -------------------------------- ### Get Job Status by ID Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk Retrieves the current status of a specific job using its unique identifier. This method is useful for a 'fire and forget' approach where you might need to check the completion status later. ```APIDOC ## getStatusById() ### Description Returns the current status of a job identified by its UUID. ### Method Signature `getStatusById(uuid: String): WorkStatus` ### Parameters * **uuid** (String) - Required - The unique identifier of the job. ### Return Value * **WorkStatus** - The current status of the job (e.g., FINISHED, FAILED, RUNNING). ### Example ```kotlin val uuid = sdk.addTag("example@user.com", "ExampleTag") val status = sdk.getStatusById(uuid) //... if (status == WorkStatus.FINISHED) { Log.i("Mailchimp SDK", "Tag Was Added") } ``` ``` -------------------------------- ### Add a Contact Event Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk Record an event associated with a contact, including the contact's email, event name, and optional properties. Note that on Android, these requests execute immediately and are not retried. ```kotlin val mailchimpSdk = Mailchimp.sharedInstance() val eventProperties = mapOf("item_id" to "12894309543") mailchimpSdk.addContactEvent("example@email.com", "User Browsed Item", eventProperties) ``` -------------------------------- ### Basic HTTP Authentication Source: https://mailchimp.com/developer/marketing/docs/fundamentals Authenticate requests using HTTP Basic Authentication with your API key or OAuth 2.0 token. ```APIDOC ## Basic HTTP Authentication ### Description Authenticate requests using HTTP Basic Authentication with your API key or OAuth 2.0 token. ### Method GET ### Endpoint `https://.api.mailchimp.com/3.0/` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```bash curl --request GET \ --url 'https://.api.mailchimp.com/3.0/' \ --user 'anystring:TOKEN' ``` ### Response #### Success Response (200) Details about the API root. #### Response Example ```json { "lists": { "href": "https://.api.mailchimp.com/3.0/lists" }, "campaigns": { "href": "https://.api.mailchimp.com/3.0/campaigns" } } ``` ``` -------------------------------- ### Time-limit an account export Source: https://mailchimp.com/developer/marketing/docs/export-api Generate an export that includes data created after a specific ISO8601 timestamp. This allows you to retrieve only recent data. ```bash curl -X POST \ https://${dc}.api.mailchimp.com/3.0/account-exports \ --user "anystring:${apikey}" \ -d '{"include_stages":["audiences", "gallery_files"], "since_timestamp": 2000-04-04T00:00:01+00:00}' ``` -------------------------------- ### Download previous exports Source: https://mailchimp.com/developer/marketing/docs/export-api Retrieve a list of all previously completed exports within the last 90 days and download them using the provided URLs. ```APIDOC ## GET /account-exports ### Description Retrieves a list of completed account exports from the last 90 days and provides download URLs. ### Method GET ### Endpoint `https://${dc}.api.mailchimp.com/3.0/account-exports` ### Parameters None ### Response #### Success Response (200) - **exports** (array) - A list of export objects. - Each export object contains: - **id** (string) - The unique identifier for the export job. - **status** (string) - The status of the export job (e.g., 'complete'). - **created_at** (string) - The timestamp when the export was requested. - **completed_at** (string) - The timestamp when the export was completed. - **download_url** (string) - The URL to download the exported data. #### Response Example ```json { "exports": [ { "id": "a1b2c3d4e5f678901234567890abcdef", "status": "complete", "created_at": "2023-10-26T09:00:00Z", "completed_at": "2023-10-26T10:30:00Z", "download_url": "https://storage.googleapis.com/mailchimp-exports/your_export_file.zip?signature=..." } ] } ``` ``` -------------------------------- ### Basic HTTP Authentication Source: https://mailchimp.com/developer/marketing/docs Authenticate your API requests using HTTP Basic Authentication with your API key or OAuth 2.0 token. ```APIDOC ## Basic HTTP Authentication ### Description Authenticate API requests using HTTP Basic Authentication. ### Method GET ### Endpoint `https://.api.mailchimp.com/3.0/` ### Parameters #### Request Headers - **Authorization** (string) - Required - `"Basic "` ### Request Example ```bash curl --request GET \ --url 'https://.api.mailchimp.com/3.0/' \ --user 'anystring:TOKEN' ``` ``` -------------------------------- ### Add GDPR Permissions to a Contact Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk This method allows you to set GDPR marketing permissions for a contact when creating or updating them. You need to use your audience-specific keys for each permission. ```APIDOC ## Add GDPR permissions ### Description GDPR-compliant audiences require each user to consent to receiving email, direct mail, and customized online advertising. These permissions are represented as a combination of an audience-specific key and a boolean value, with `true` indicating consent. ### Method Signature `Contact.Builder.setMarketingPermission(permissionKey: String, consent: Boolean)` ### Parameters - **permissionKey** (String) - Required - The audience-specific key for the GDPR permission (e.g., email, direct mail, advertising). - **consent** (Boolean) - Required - `true` if the user has consented, `false` otherwise. ### Request Example (Android) ```kotlin val emailPermissionKey = "YOUR_AUDIENCE_EMAIL_KEY" val mailPermissionKey = "YOUR_AUDIENCE_MAIL_KEY" val advertisingPermissionKey = "YOUR_AUDIENCE_ADVERTISING_KEY" val newContact = Contact.Builder("example@email.com") .setMarketingPermission(emailPermissionKey, true) .setMarketingPermission(mailPermissionKey, true) .setMarketingPermission(advertisingPermissionKey, true) .build() val sdk = Mailchimp.sharedInstance() sdk.createOrUpdateContact(newContact) ``` ``` -------------------------------- ### Default Query String Parameters for Pagination Source: https://mailchimp.com/developer/marketing/docs/methods-parameters Use offset and count in the URL query string to paginate API requests and retrieve data in manageable chunks. The maximum value for count is 1000, and it defaults to 10. Offset defaults to 0. ```url https://usX.api.mailchimp.com/3.0/campaigns?offset=0&count=10 ``` -------------------------------- ### Monitor Job State with LiveData Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk Observe job status changes using LiveData. This allows for real-time UI updates based on job progression. ```kotlin val uuid = sdk.addTag("example@user.com", "ExampleTag") val statusLiveData = sdk.getStatusByIdLiveData(uuid) statusLiveData.observe( this Observer { Toast.makeText(this, "Current Job Status: $it", Toast.LENGTH_SHORT).show() } ) ``` -------------------------------- ### Generate a new account export Source: https://mailchimp.com/developer/marketing/docs/export-api Use this endpoint to request a new export of your Mailchimp account data. Specify the data stages you wish to include in the export. ```bash curl -X POST \ https://${dc}.api.mailchimp.com/3.0/account-exports \ --user "anystring:${apikey}" \ -d '{"include_stages":["audiences", "gallery_files"]}' ``` -------------------------------- ### Generate a New Account Export Source: https://mailchimp.com/developer/marketing/docs/account-exports This endpoint allows you to request a new export of your Mailchimp account data. You can specify which categories of data to include using the `include_stages` parameter. The export will be built in the background and can be downloaded later. ```APIDOC ## POST /3.0/account-exports ### Description Generates a new export of Mailchimp account data. You can specify which data categories to include. ### Method POST ### Endpoint `https://${dc}.api.mailchimp.com/3.0/account-exports` ### Parameters #### Request Body - **include_stages** (array of strings) - Required - Specifies the categories of data to include in the export. Possible values: `audiences`, `campaigns`, `events`, `gallery_files`, `reports`, `templates`. - **since_timestamp** (string) - Optional - An ISO8601 timestamp to limit the export to content generated after this time. ### Request Example ```json { "include_stages": ["audiences", "gallery_files"] } ``` ### Request Example with Time Limit ```json { "include_stages": ["audiences", "gallery_files"], "since_timestamp": "2000-04-04T00:00:01+00:00" } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the export job. - **status** (string) - The current status of the export job (e.g., `generating`, `complete`, `failed`). - **created_at** (string) - The timestamp when the export was requested. - **completed_at** (string) - The timestamp when the export was completed. - **download_url** (string) - The URL to download the exported data (available when status is `complete`). #### Response Example ```json { "id": "a1b2c3d4e5f678901234567890abcdef", "status": "generating", "created_at": "2023-10-27T10:00:00+00:00", "completed_at": null, "download_url": null } ``` ``` -------------------------------- ### Combine Multiple Segment Conditions Source: https://mailchimp.com/developer/marketing/docs/alternative-schemas Use the `conditions` array to combine multiple segment criteria. The `match` option can be set to 'all' or 'any' to specify the logic. ```json { "name": "Gmail users who subscribed in 2021 or later", "options": { "match": "all", "conditions": [ { "field": "timestamp_opt", "op": "greater", "value": "date", "extra": "2021-01-01" }, { "field": "EMAIL", "op": "contains", "value": "gmail.com" } ] } } ``` -------------------------------- ### Generate a new export Source: https://mailchimp.com/developer/marketing/docs/export-api Request a new export of your Mailchimp account data. You can specify which data categories to include using the `include_stages` parameter. ```APIDOC ## POST /account-exports ### Description Generates a new export of account data. Allows specifying data categories to include. ### Method POST ### Endpoint `https://${dc}.api.mailchimp.com/3.0/account-exports` ### Parameters #### Request Body - **include_stages** (array) - Required - A list of data categories to include in the export. Possible values include: `audiences`, `campaigns`, `events`, `gallery_files`, `reports`, `templates`. - **since_timestamp** (string) - Optional - An ISO8601 timestamp to limit the export to data generated after this time. ### Request Example ```json { "include_stages": ["audiences", "gallery_files"], "since_timestamp": "2000-04-04T00:00:01+00:00" } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the export job. - **status** (string) - The current status of the export job (e.g., 'generating', 'complete', 'failed'). - **created_at** (string) - The timestamp when the export was requested. - **completed_at** (string) - The timestamp when the export was completed. - **download_url** (string) - The URL to download the exported data (available when status is 'complete'). #### Response Example ```json { "id": "a1b2c3d4e5f678901234567890abcdef", "status": "generating", "created_at": "2023-10-27T10:00:00Z", "completed_at": null, "download_url": null } ``` ``` -------------------------------- ### HTTP 405 Method Not Allowed Error Response Source: https://mailchimp.com/developer/marketing/docs/errors This snippet shows a typical HTTP response for a 405 Method Not Allowed error. It includes headers that provide information about the request and response. ```http HTTP/1.1 405 Method Not Allowed Server: nginx Content-Type: application/problem+json; charset=utf-8 Content-Length: 253 X-Request-Id: a1efb240-f8d8-40fe-a680-c3a5619a42e9 Link: ; rel="describedBy" Date: Thu, 17 Sep 2015 19:02:28 GMT Connection: keep-alive Set-Cookie: _AVESTA_ENVIRONMENT=prod; path=/ ``` -------------------------------- ### Bearer Authentication Source: https://mailchimp.com/developer/marketing/docs Authenticate your API requests using Bearer Authentication with your OAuth 2.0 access token. ```APIDOC ## Bearer Authentication ### Description Authenticate API requests using Bearer Authentication with an OAuth 2.0 token. ### Method GET ### Endpoint `https://.api.mailchimp.com/3.0/` ### Parameters #### Request Headers - **Authorization** (string) - Required - `"Bearer "` ### Request Example ```bash --url 'https://.api.mailchimp.com/3.0/' \ --header "Authorization: Bearer " ``` ``` -------------------------------- ### Bearer Authentication Source: https://mailchimp.com/developer/marketing/docs/fundamentals Authenticate requests using Bearer Authentication with your OAuth 2.0 access token. ```APIDOC ## Bearer Authentication ### Description Authenticate requests using Bearer Authentication with your OAuth 2.0 access token. ### Method GET ### Endpoint `https://.api.mailchimp.com/3.0/` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```bash curl --request GET \ --url 'https://.api.mailchimp.com/3.0/' \ --header "Authorization: Bearer " ``` ### Response #### Success Response (200) Details about the API root. #### Response Example ```json { "lists": { "href": "https://.api.mailchimp.com/3.0/lists" }, "campaigns": { "href": "https://.api.mailchimp.com/3.0/campaigns" } } ``` ``` -------------------------------- ### Add Mailchimp SDK to iOS Project via Cocoapods Source: https://mailchimp.com/developer/marketing/docs/mobile-sdk To add the Mailchimp Mobile SDK to your iOS app using Cocoapods, include this line in your project's Podfile. ```ruby pod 'MailchimpSDK' ```