Person importapifinished

Person import from API finished.

WEBHOOK person_import.api.finished

Example

{
  "_eventType": "person_import.api.finished",
  "importId": "test_cm1uwhduy001vle4gr4soyqkq",
  "status": "COMPLETED",
  "updatedAt": "2024-09-01T00:00:00Z",
  "failedRecords": [
    {
      "personId": "test_cm1uwhduy001vle4gr4soyqkq"
    },
    {
      "email": "[e-mail]"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

_eventType · enum<string> · required

Available options: person_import.api.finished

importId · string · required

Unique identifier of the import.

status · enum<string> · required

Status of the import.

Available options: NOT_STARTED, UPLOADING, ERROR, COMPLETED

updatedAt · string<date-time> · required

Timestamp the import finished.

failedRecords · object[] | null · required

Option 1

Option 2

Show child attributes

Response

200

Success