/data/members/profiles/batch – Alida Help Center

Generate a batch identifier to create an export job for all your member profile data.

Note: This endpoint is used to export member profile data sorted by members. For more information about exporting member profile data sorted by profile variables, see /datasets/profile/{datasetId}/batch.

Resource URL

https://api.{region}.alida.com/v2/applications/{communityApiKeyName}/data/members/profiles/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
`sinceDatetime`	The `sinceDatetime` parameter is optional and used to return all new or updated member profiles that occurred after the specific date and time. Dates and times need to follow an ISO 8601 UTC format.
`variableIds`	The GUID(s) of profile variables specified. Note: Up to 500 profile variables can be specified in a single export job.

Example POST body

{
    "variableIds": [<GUID of the profile variable id(s)>],	
    "sinceDatetime": <YYYY-MM-DDThh:mm:ss.msZ>
}

Available fields

Element	Description
`id`	A string GUID of the `batchId`.

Example

{
    "id": <GUID of the batchId>
}