Imports

Confirm the mapping and start execution

Changed on

Confirms the proposed (or an inline) mapping and starts the async imports.confirm execution operation.

post/imports/{id}/confirm

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/imports/{id}/confirm
  • Auth: HTTP bearer

Path parameters

idstring required

The import batch ID.

Request body

Response

Execution operation started.

idstring required

Unique identifier for the object.

object'operation' required

String representing the object's type. Objects of the same type share the same value.

kind'domains.verify' | 'imports.parse' | 'imports.confirm' | 'subscribers.export' | 'subscribers.import' | 'custom_objects.records_import' | 'exports.generate' | 'candidates.remove' | 'employers.remove' required

Operation kind, identifying which workflow the operation runs.

state'pending' | 'running' | 'succeeded' | 'failed' | 'cancelled' required

Current state of the operation.

createdAtstring required

Time at which the operation was created. ISO 8601 datetime.

updatedAtstring required

Time at which the operation was last updated. ISO 8601 datetime.

completedAtstring nullable required

Time at which the operation reached a terminal state, or null if it has not yet completed. ISO 8601 datetime.

cancelRequestedboolean required

Whether cancellation of the operation has been requested.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status