Send a new request

POST /request

This endpoint allows you to send a new request to a new contacts or to an existing contact.

application/json

Body

  • campaignId string Required

    The ID of the campaign you want to use to send a request.

  • contact string | object Required
    One of:
  • items array[string]

    An array of itemId. If you want to request only few elements of the campaign, you can optionaly specify which elements you want to include in your request.

  • data object

    An object with custom data that you want to use in your request.

  • sample object

    An object that represents the sample of a document element. The object must contain 2 parameters: 'itemId' and 'url'.

    Hide sample attributes Show sample attributes
  • dueDate string

    The due date of the request. The due date should be encoded as a string using ISO 8601 format.

  • The ID of the user that is sending the request. This user must have access to the request.

  • The ID of the team member you want to assign the request to. You can also use the email address of the team member.

  • Boolean. If set to false, the sequence of messages planned in your campaign will not be sent.

  • Boolean. If set to true, a message will be automatically send when the request status will be changed to "completed". This message can be customized in the branding settings used for this campaign.

  • Boolean. If set to true, a message will be automatically send when the request status will be changed to "pending" and at least one element on the portal has been rejected. This message can be customized in the branding settings used for this campaign.

  • Boolean. If set to true, a message will be automatically send when the request status will be changed to "pending". This message can be customized in the branding settings used for this campaign.

Responses

POST /request
curl \
 -X POST https://api.usecollect.com/v1/request \
 --user "username:password" \
 -H "Content-Type: application/json" \
 -d '{"campaignId":"xvr69EYLKXvTkfYuk","contact":{"email":"elon@example.com","firstName":"Elon","lastName":"Musk","company":"Tesla","data":{"brand":"Tesla","model":"Roadster"}}}'
Request examples
{
  "campaignId": "xvr69EYLKXvTkfYuk",
  "contact": {
    "email": "elon@example.com",
    "firstName": "Elon",
    "lastName": "Musk",
    "company": "Tesla",
    "data": {
      "brand": "Tesla",
      "model": "Roadster"
    }
  }
}
{
  "campaignId": "xvr69EYLKXvTkfYuk",
  "contact": "WmTjsFknzHdmfs3Ra"
}
Response examples (200)
{
  "request": {
    "_id": "nw42MmBsJoccgutST",
    "campaignId": "xvr69EYLKXvTkfYuk",
    "createdAt": "2022-07-04 07:20:06 UTC",
    "portalUrl": "https://app.usecollect.com/portal/uGFRDeEL3Ct2uYo2c/nw42MmBsJoccgutST",
    "status": "pending",
    "dueDate": "2022-07-11 21:59:00 UTC",
    "privacy": "private",
    "contact": {
      "_id": "WmTjsFknzHdmfs3Ra",
      "email": "johndoe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "nbRequest": 5,
      "createdAt": "2022-07-03 13:51:27 UTC",
      "lastActivity": "2022-07-04 07:20:06 UTC"
    },
    "branding": {
      "useBranding": false
    }
  },
  "errors": []
}