businesses

Start Contact Sync

Changed on

Start a sync for one source. 409 if one is already running.

{source_key:path} because a PMS key is pms:<provider> and a bare path parameter would stop at the colon.

post/api/v1/contact-sources/{source_key}/sync

Request

  • Base URL: https://api.getanana.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.getanana.com/api/v1/contact-sources/{source_key}/sync
  • Auth: none declared

Path parameters

source_keystring required

Request body

report_onlyboolean

Response

Successful Response

idstring uuid required
providerstring required
source_keystring required
statusstring required
phasestring required
report_onlyboolean required
countersobject
contacts_importedinteger required
contacts_updatedinteger required
contacts_skippedinteger required
companies_importedinteger required
companies_updatedinteger required
associations_madeinteger required
error_messagestring nullable
started_atstring date-time nullable
finished_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

  • d65b8fefae34Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status