Send a new request
This endpoint allows you to send a new request to a new contacts or to an existing contact.
Body
-
campaignId string Required
The ID of the campaign you want to use to send a request.
- contact string | object Required
-
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'.
-
dueDate string
The due date of the request. The due date should be encoded as a string using ISO 8601 format.
-
createdBy string
The ID of the user that is sending the request. This user must have access to the request.
-
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.
Responses
-
• 200 object
List of requests of a campaigns.
-
• 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.
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"}}}'
{
"campaignId": "xvr69EYLKXvTkfYuk",
"contact": {
"email": "elon@example.com",
"firstName": "Elon",
"lastName": "Musk",
"company": "Tesla",
"data": {
"brand": "Tesla",
"model": "Roadster"
}
}
}
{
"campaignId": "xvr69EYLKXvTkfYuk",
"contact": "WmTjsFknzHdmfs3Ra"
}
{
"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": []
}