Generate a batchId to create an export for all profile variables and records associated with members.
Note: This endpoint is used to export member profile
data sorted by profile variables. For more information about exporting member
profile data sorted by members, see
/data/members/profiles/batch.
Prerequisite
- Obtain the
datasetId/applicationIdby making a request to /datasets/profile.
Resource URL
/v2/applications/{communityApiKeyName}/datasets/profile/{datasetId}/batch
Note:
Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see Shared responsibility.
Available methods
| Method | Description |
|---|---|
| POST | Create a
batchId.
|
Parameters
If you want to select specific profile variables to export, create a
POST with profile variable
id(s).
Note: Set the
Content-Type header as
application/json to prevent any errors that can occur.
| Parameter | Description |
|---|---|
fieldsIds
|
The GUID(s) of profile variables specified.
Note: Up to 500 profile variables can be specified in a single
export job.
|
Example POST body
{
"fieldIds": [<GUID of the profile variable id(s)>],
}
Available fields
| Element | Description |
|---|---|
id
|
A string GUID of the
|
Example
{
"id": <GUID of the batchId>
}