Domains

Verify a custom domain

Changed on

Starts an asynchronous domains.verify operation for the custom domain.

post/domains/{id}/verify

Request

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

Path parameters

idstring required

The custom domain ID.

Response

Verification 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