Send multiple requests

POST /requests

This endpoint allows you to send multiple requests to new contacts or existing contacts.

application/json

Body

  • campaignId string Required

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

  • contacts array[string | object] Required

    An array of the contacts you want to send the request to. You can send requests up to 50 contacts per API call (considering your account's limitation). Each contact can be a string representing the ID of an existing contact or a contact object in JSON format. (click here for more details)

    One of:
    Contact Id string Contact Object object
  • items array[string]

    An array of itemId. If you want to request only few items (documents and forms) of the campaign, you can optionaly specify which items you want to retrieve.

  • samples object

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

    Hide samples attributes Show samples attributes object
  • dueDate string

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

  • assignedTo string

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

  • sendMessage boolean

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

  • sendCompletionMessage boolean

    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.

  • sendRejectionMessage boolean

    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.

  • sendReopenMessage boolean

    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 /requests 
curl \
 -X POST https://api.usecollect.com/v1/requests \
 -H "Content-Type: application/json" \
 -d '{"contacts":["WmTjsFknzHdmfs3Ra",{"email":"elon@example.com","lastName":"Musk","firstName":"Elon"}],"campaignId":"xvr69EYLKXvTkfYuk"}'
Request example 
{
  "contacts": [
    "WmTjsFknzHdmfs3Ra",
    {
      "email": "elon@example.com",
      "lastName": "Musk",
      "firstName": "Elon"
    }
  ],
  "campaignId": "xvr69EYLKXvTkfYuk"
}
Response examples (200) 
{
  "errors": [],
  "contacts": [
    "WmTjsFknzHdmfs3Ra",
    {
      "_id": "ngxhLDiDGEBS2jjKh",
      "email": "elon@example.com",
      "lastName": "Musk",
      "createdAt": "2022-07-04T07:20:06Z",
      "firstName": "Elon"
    }
  ],
  "requests": [
    {
      "_id": "nw42MmBsJoccgutST",
      "status": "pending",
      "contact": {
        "_id": "WmTjsFknzHdmfs3Ra",
        "email": "johndoe@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",
      "sendCompletionMessage": true
    },
    {
      "_id": "jdDzbxP8MnfBdrRuM",
      "status": "pending",
      "contact": {
        "_id": "ngxhLDiDGEBS2jjKh",
        "email": "elon@example.com",
        "company": "Tesla",
        "lastName": "Musk",
        "createdAt": "2022-07-04T07:20:06Z",
        "firstName": "Elon",
        "nbRequest": 1,
        "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/jdDzbxP8MnfBdrRuM",
      "campaignId": "xvr69EYLKXvTkfYuk"
    }
  ]
}