Export customer data

Provide filters and attributes describing the customers you want to export. This endpoint returns export metadata; use the /exports/{export_id}/endpoint to download your export.

post/v1/exports/customers

Request body

attributesstring[]

Recipient attributes you want to include as extra columns in your export.

Example request

{
  "filters": {
    "and": [
      {
        "or": [
          {
            "segment": {
              "id": 4
            }
          }
        ],
        "not": {
          "and": [
            {
              "segment": {
                "id": 4
              }
            }
          ]
        },
        "segment": {
          "id": 4
        },
        "attribute": {
          "field": "unsubscribed",
          "operator": "eq",
          "value": true
        }
      }
    ]
  }
}

Response

Returns an export.

Example response

{
  "export": {
    "id": 110,
    "user_id": 0,
    "user_email": "person@email.com",
    "total": 1234,
    "deduplicate_id": "110:1530296738",
    "type": "customers",
    "failed": false,
    "status": "done",
    "description": "Customers with segment filters—in \\Purchased Flowers\\",
    "downloads": 2,
    "created_at": 1530296738,
    "updated_at": 1530296738
  }
}

Changes

Changed in 1 of the 3 revisions of this API.1

Sep 2, 20265da2740beeb51See the full diff
- ○
  added the media type application/json for the response with the status
  response-media-type-added

Full history