Create export

Create bulk export. Supported exports are contacts and activities.

Request

POST https://api.connectif.cloud/exports/

Request body

The request body takes a complete ExportCreation resource, containing the following writable properties:

{
    "dateFormat": "string",
    "delimiter": "string",
    "exportType": "string",
    "filters": {
        "activityTypes": [
            "string"
        ],
        "fromDate": "date-time",
        "segmentId": "string",
        "toDate": "date-time"
    }
}

Properties

Name Type Description Additional
dateFormat string

The file dates format

Possible values are:

  • ISO
  • L
  • LL
  • LLL
delimiter string

The file delimiter

Possible values are:

  • ,
  • ;
exportType string

The export type

Possible values are:

  • contacts
  • activities
filters object

The export filters

 Optional
filters.activityTypes[] array of string

Filter by activity types. This field can be set only for "activities" export type but is optional. If it is not provided, no filter will be applied

 Optional
filters.fromDate date-time

Filter from a given date in ISO8601 format. This field can be set only for "activities" export type and it is required. The range between fromDate and toDate cannot be greater than 31 days.

 Optional
filters.segmentId string

Filter by contacts that are in a given segment. It applies for both "contacts" and "activities" export types

 Optional
filters.toDate date-time

Filter to a given date in ISO8601 format. This field can be set only for "activities" export type and it is required. The range between fromDate and toDate cannot be greater than 31 days.

 Optional

Authorization

This request requires the use of one of following authorization methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Success.

 Export
400 Bad Request

Bad request, i.e.: invalid json.

 HttpError
401 Unauthorized

Not authorized to access API.
403 Forbidden

Permission not granted to the API Key or account has been blocked.

 HttpError
415 Unsupported Media Type

Request without application/json Content-Type header.

 HttpError
422 Unprocessable Entity

Resource contains validation errors.

 HttpUnprocessableEntityError
429 Too Many Requests

Requests rate limit reached.