API Resources

Admin - Import Profiles API

Manage importing of profiles.

Interfaces

View Import Profile

GET /api/admin/import_profile

This endpoint exposes the import profile for an account.

Response codes

  • 200 OK
  • 401 Unauthorized

Example Response

{
  "id": 1,
  "csv_days": [false, false, false, false, false, false, false],
  "csv_time": null,
  "has_headers": false,
  "import_columns": [
    {
      "custom_field_id": 1,
      "name": "department",
      "position": 1,
      "primary_field": false
    }
  ]
}

Update import profile

PATCH /api/admin/import_profile
PUT /api/admin/import_profile

A PUT action with json payload to update import profile

Response Codes

  • 200 OK
  • 401 Unauthorized

Parameters

  • csv_url String Required

    Body parameter

  • csv_user String Required

    Body parameter

  • csv_password String Required

    Body parameter

  • has_headers Boolean Required

    Body parameter

  • csv_days String Required

    Body parameter

  • csv_time String Required

    Body parameter

  • columns Hash Required

    Body parameter. A map of column definitions

Example Request

JSON cURL 
{
  "has_headers" : true,
  "columns": {
    "0": [
      "first_name",
      "last_name",
      "uid"
    ]
  }
}
curl \
  -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"has_headers":true,"columns":{"0":["first_name","last_name","uid"]}}' \
  http://<bridge>/api/admin/import_profile

Example Response

{
  "id": 1,
  "csv_days": [false, false, false, false, false, false, false],
  "csv_time": null,
  "has_headers": false,
  "import_columns": [
    {
      "custom_field_id": 1,
      "name": "department",
      "position": 1,
      "primary_field": false
    }
  ]
}

Returns import profile file

GET /api/admin/import_profile/file

A GET action to send binary import profile file data to the requesting browser

Response Codes

  • 200 OK
  • 401 Unauthorized