search
HomeHelp

Csv

Csv Documentation

hashtag
CSV Import [LIST]

List of CSV Imports associated with the Account List

hashtag
Request

hashtag
Endpoint

GET /api/v2/account_lists/2c790005-2b66-4a82-a285-a2df94703a17/imports/csv
Content-Type: multipart/form-data

hashtag
Body

hashtag
Response

hashtag
Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

hashtag
Body

{
  "data": [
    {
      "id": "7a307798-c5bb-450b-bf50-46d6b99926d7",
      "type": "imports",
      "attributes": {
        "account_list_id": "2c790005-2b66-4a82-a285-a2df94703a17",
        "created_at": "2022-01-12T17:18:35Z",
        "file_constants": {
        },
        "file_constants_mappings": {
          "status": [
            {
              "id": "Partner - Financial",
              "values": [
                "Praying and giving"
              ]
            }
          ],
          "pledge_frequency": [
            {
              "id": "1.0",
              "values": [
                "Monthly"
              ]
            }
          ],
          "newsletter": [
            {
              "id": "Both",
              "values": [
                "Both"
              ]
            }
          ]
        },
        "file_headers": {
        },
        "file_headers_mappings": {
          "city": "city",
          "pledge_amount": "amount",
          "pledge_frequency": "frequency",
          "contact_name": "fname",
          "country": "country",
          "email_1": "email_address",
          "envelope_greeting": "envelope_greeting",
          "first_name": "fname",
          "greeting": "greeting",
          "last_name": "lname",
          "newsletter": "newsletter",
          "notes": "extra_notes",
          "phone_1": "phone",
          "spouse_email": "spouse_email_address",
          "spouse_first_name": "spouse_fname",
          "spouse_last_name": "spouse_lname",
          "spouse_phone": "spouse_phone_number",
          "state": "province",
          "status": "status",
          "street": "street",
          "zip": "zip_code"
        },
        "file_url": "http://api.mpdx.test/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9JYTJWNVNTSWhkV0oxWkhGbWQzazFOVFZtWW5Kc00zWXlNbXRxTURObU16SnliZ1k2QmtWVU9oQmthWE53YjNOcGRHbHZia2tpWDJGMGRHRmphRzFsYm5RN0lHWnBiR1Z1WVcxbFBTSnpZVzF3YkdWZlkzTjJYM1J2WDJsdGNHOXlkQzVqYzNZaU95Qm1hV3hsYm1GdFpTbzlWVlJHTFRnbkozTmhiWEJzWlY5amMzWmZkRzlmYVcxd2IzSjBMbU56ZGdZN0JsUTZFV052Ym5SbGJuUmZkSGx3WlVraUQzUmxlSFF2Y0d4aGFXNEdPd1pVT2hGelpYSjJhV05sWDI1aGJXVTZDWFJsYzNRPSIsImV4cCI6IjIwMjItMDEtMTJUMTc6MjM6MzVaIiwicHVyIjoiYmxvYl9rZXkifX0=--a4db7aa9ca1378192c5435f24e843b44061defe2/sample_csv_to_import.csv",
        "group_tags": null,
        "groups": [

        ],
        "import_by_group": false,
        "in_preview": true,
        "override": false,
        "source": "csv",
        "tag_list": null,
        "updated_at": "2022-01-12T17:18:35Z",
        "updated_in_db_at": "2022-01-12T17:18:35Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "2c34a842-4b04-47fd-9399-d558c7322a7f",
            "type": "users"
          }
        },
        "sample_contacts": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "1dc92edd-28e9-4d7e-a539-dfe37416058d",
      "type": "imports",
      "attributes": {
        "account_list_id": "2c790005-2b66-4a82-a285-a2df94703a17",
        "created_at": "2022-01-12T17:18:35Z",
        "file_constants": {
        },
        "file_constants_mappings": {
          "status": [
            {
              "id": "Partner - Financial",
              "values": [
                "Praying and giving"
              ]
            }
          ],
          "pledge_frequency": [
            {
              "id": "1.0",
              "values": [
                "Monthly"
              ]
            }
          ],
          "newsletter": [
            {
              "id": "Both",
              "values": [
                "Both"
              ]
            }
          ]
        },
        "file_headers": {
        },
        "file_headers_mappings": {
          "city": "city",
          "pledge_amount": "amount",
          "pledge_frequency": "frequency",
          "contact_name": "fname",
          "country": "country",
          "email_1": "email_address",
          "envelope_greeting": "envelope_greeting",
          "first_name": "fname",
          "greeting": "greeting",
          "last_name": "lname",
          "newsletter": "newsletter",
          "notes": "extra_notes",
          "phone_1": "phone",
          "spouse_email": "spouse_email_address",
          "spouse_first_name": "spouse_fname",
          "spouse_last_name": "spouse_lname",
          "spouse_phone": "spouse_phone_number",
          "state": "province",
          "status": "status",
          "street": "street",
          "zip": "zip_code"
        },
        "file_url": "http://api.mpdx.test/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9JYTJWNVNTSWhiV0Z2WVhkeGNIZDBNemg0YVdWMmJERmxiM0pqYjJKNU5IVnRNZ1k2QmtWVU9oQmthWE53YjNOcGRHbHZia2tpWDJGMGRHRmphRzFsYm5RN0lHWnBiR1Z1WVcxbFBTSnpZVzF3YkdWZlkzTjJYM1J2WDJsdGNHOXlkQzVqYzNZaU95Qm1hV3hsYm1GdFpTbzlWVlJHTFRnbkozTmhiWEJzWlY5amMzWmZkRzlmYVcxd2IzSjBMbU56ZGdZN0JsUTZFV052Ym5SbGJuUmZkSGx3WlVraUQzUmxlSFF2Y0d4aGFXNEdPd1pVT2hGelpYSjJhV05sWDI1aGJXVTZDWFJsYzNRPSIsImV4cCI6IjIwMjItMDEtMTJUMTc6MjM6MzVaIiwicHVyIjoiYmxvYl9rZXkifX0=--a9b9a96abf34202736823219d00e9f9d82477ff1/sample_csv_to_import.csv",
        "group_tags": null,
        "groups": [

        ],
        "import_by_group": false,
        "in_preview": true,
        "override": false,
        "source": "csv",
        "tag_list": null,
        "updated_at": "2022-01-12T17:18:35Z",
        "updated_in_db_at": "2022-01-12T17:18:35Z"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "2c34a842-4b04-47fd-9399-d558c7322a7f",
            "type": "users"
          }
        },
        "sample_contacts": {
          "data": [

          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 2,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

hashtag
CSV Import [GET]

The Import with the given ID

hashtag
Request

hashtag
Endpoint

hashtag
Body

hashtag
Response

hashtag
Headers

hashtag
Body

hashtag
CSV Import [CREATE]

Creates a new CSV Import associated with the Account List. This endpoint expects a CSV file to be uploaded using Content-Type "multipart/form-data", this makes the endpoint unique in that it does not expect only JSON content. Unless otherwise specified, the Import will be created with "in_preview" set to true.

A CSV Import is expected to take multiple steps to setup:

1. The first step is to create a new Import via a POST request, the client can upload the CSV file in the POST request using "multipart/form-data". If the file upload is successful then the file_headers and file_constants will be returned to the client in the response.

2. In the second step the client is expected to update (via PUT) the file_headers_mappings according to the user's desire (based on the file_headers). This step could take several attempts.

3. In the third step the client is expected to update (via PUT) the file_constants_mappings according to the user's desire (based on the file_constants). This step could take several attempts.

4. The fourth step is to show a sample of the import to the user. The sample_contacts relationship should be used.

5. The fifth step is to start the import. The client is expected to update (via PUT) the "in_preview" attribute to "false", which will trigger the import to begin (as a background job). If the mappings are incorrect or incomplete, or the record is otherwise invalid, then the import will not begin and an error object will be returned instead.

hashtag
Request

hashtag
Endpoint

hashtag
Body

hashtag
Response

hashtag
Headers

hashtag
Body

hashtag
CSV Import [UPDATE]

Update a CSV Import associated with the Account List. For more details regarding the CSV Import see the description on the create request.

hashtag
Request

hashtag
Endpoint

hashtag
Body

hashtag
Response

hashtag
Headers

hashtag
Body

PreviousImportsNextGoogle

Last updated