Trigger docs sync

POST /syncdocs

This endpoint allows you to trigger the synchronisation of uploaded documents to a cloud storage. Only the documents that have not been synced so far will be sent to the cloud.

application/json

Body

requestId string Required

The ID of the request you want to trigger the synchronisation.

Responses

200 application/json

Specific Request.
Hide response attributes Show response attributes object
- request object
  
  Hide request attributes Show request attributes
  
  _id string
  
  campaignId string
  
  createdAt string(date-time)
  
  portalUrl string
  
  status string
  
  dueDate string(date-time)
  
  privacy string
  
  contact object
  
  Hide contact attributes Show contact attributes
  
  _id string
  
  email string(email)
  
  firstName string
  
  lastName string
  
  company string
  
  tag array[string]
  
  custom array[object]
  
  Hide custom attributes Show custom attributes object
  
  _id string
  
  name string
  
  variable string
  
  value string
  
  branding object
  
  Hide branding attributes Show branding attributes
  
  useBranding boolean
  
  brandingId string
- errors array
400

Bad Request -- Your request is invalid.
401

Unauthorized -- Your API key is wrong.
403

Forbidden -- The object requested is hidden for administrators only.
404

Not Found -- The specified object could not be found.
429

Too Many Requests -- You're requesting too many objects! Slow down!
500

Internal Server Error -- We had a problem with our server. Try again later.
503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

POST /syncdocs

curl \
 -X POST https://api.usecollect.com/v1/syncdocs \
 -H "Content-Type: application/json" \
 -d '{"requestId":"nw42MmBsJoccgutST"}'

Request example

{
  "requestId": "nw42MmBsJoccgutST"
}

Response examples (200)

{
  "errors": [],
  "request": {
    "_id": "nw42MmBsJoccgutST",
    "status": "pending",
    "contact": {
      "_id": "xtPWKQqcAk8MJfoz5",
      "email": "maincontact@example.com",
      "lastName": "Doe",
      "createdAt": "2022-07-03T13:51:27Z",
      "firstName": "John",
      "nbRequest": 5,
      "lastActivity": "2022-07-04T07:20:06Z"
    },
    "dueDate": "2022-07-11T21:59:00Z",
    "privacy": "private",
    "branding": {
      "useBranding": false
    },
    "createdAt": "2022-07-04T07:20:06Z",
    "portalUrl": "https://app.usecollect.com/portal/uGFRDeEL3Ct2uYo2c/nw42MmBsJoccgutST",
    "campaignId": "xvr69EYLKXvTkfYuk",
    "contributors": [
      {
        "_id": "WmTjsFknzHdmfs3Ra",
        "email": "johndoe@example.com",
        "lastName": "Musk",
        "createdAt": "2022-07-03T13:51:27Z",
        "firstName": "Elon"
      }
    ]
  }
}