API referenceDirectory

Import directory entries

posthttps://api.expiryedge.com/v1/bulkImportDirectoryEntries
editor or admin60/minAny method
Request
curl -X POST 'https://api.expiryedge.com/v1/bulkImportDirectoryEntries' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entries": [
    {
      "name": "Contoso Legal",
      "type": "Vendor",
      "email": "billing@contosolegal.example"
    },
    {
      "name": "Main Street Clinic",
      "type": "Property",
      "address": "12 Main St, Springfield"
    }
  ]
}'
Response
{
  "success": true,
  "created": 2,
  "skippedDuplicates": 0,
  "totalRows": 2,
  "errors": []
}

Up to 1000 rows per request (entries, or records). Rows need a name; unknown type values become Person; Other requires customType. Rows duplicating an existing entry or another row (same name + type, case-insensitive) are skipped. No plan limit applies.

Body parameters

application/json
  • entriesarray of objects
    max items: 1000
  • recordsarray of objects
    Alias of entries.
    max items: 1000

Returns

200
Import finished (possibly partially). Row problems are listed in errors.
  • successboolean
  • errorstring
    Present on 400.
  • createdinteger
  • skippedDuplicatesinteger
  • totalRowsinteger
  • errorsarray of string

Errors

400
No rows or more than 1000 rows.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.