> For the complete documentation index, see [llms.txt](https://doc.batch.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.batch.com/developer/sdk/android/profile-data/email-subscription.md).

# Email subscription

The Batch Android SDK allows you to:

* Add and remove email address from a user profile. The profile will automatically be created if needed.
* Edit a profile's marketing subscription.

{% hint style="info" %}
In order to set an email address and subscription status on a profile, the creation of a project is required. If no project is set up, any calls made for these actions will be ignored.
{% endhint %}

Here is how to set an email with a marketing subscription:

{% tabs %}
{% tab title="Kotlin" %}

```kotlin
// This requires to have a custom user ID registered 
// by calling the `identify` method beforehand.
Batch.Profile.editor().apply {
  setEmailAddress("john.doe@batch.com") // Null to erase. Addresses must be valid.
  setEmailMarketingSubscription(BatchEmailSubscriptionState.SUBSCRIBED) // or BatchEmailSubscriptionState.UNSUBSCRIBED
  save()
}
```

{% endtab %}

{% tab title="Java" %}

```java
// This requires to have a custom user ID registered 
// by calling the `identify` method beforehand.
Batch.Profile.editor()
  .setEmailAddress("john.doe@batch.com") // Null to erase. Addresses must be valid.
  .setEmailMarketingSubscription(BatchEmailSubscriptionState.SUBSCRIBED) // or BatchEmailSubscriptionState.UNSUBSCRIBED
  .save();
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.batch.com/developer/sdk/android/profile-data/email-subscription.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.