Collect API documentation

Add a contact

POST /contacts

This endpoint add a new contact. It returns the contact object.

application/json

Body Required

firstName string

First name of the contact
lastName string

Last name of the contact
email string

Email of the contact
company string

Company name of the contact
tag array[string]

List of tags for the contact
customFields array[object]
Hide customFields attributes Show customFields attributes object
- _id string
- name string
- variable string
- value string

Responses

• 200 application/json

Success
Hide response attributes Show response attributes object
- _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
- campaignId string
- createdAt string
- status string
- privacy string
- branding object
  
  Hide branding attributes Show branding attributes
  
  useBranding boolean
  
  brandingId string
- note object
  
  Hide note attributes Show note attributes
  
  date string
  
  note string
• 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 /contacts

curl \
 -X POST https://api.usecollect.com/v1/contacts \
 --user "username:password" \
 -H "Content-Type: application/json" \
 -d '{"email":"john@example.com","firstName":"John","lastName":"Doe","tags":["Speaker"],"customFields":[{"variable":"color","value":"Blue"},{"variable":"country","value":"US"}]}'

Request example

{
  "email": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "tags": [
    "Speaker"
  ],
  "customFields": [
    {
      "variable": "color",
      "value": "Blue"
    },
    {
      "variable": "country",
      "value": "US"
    }
  ]
}

Response examples (200)

{
  "_id": "uBJadNFcjrC6emRom",
  "email": "johndoe@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "nbRequest": 0,
  "tag": [
    "Speaker"
  ],
  "custom": [
    {
      "_id": "yw6XDyeFvbqr86yA6",
      "name": "Favorite color",
      "variable": "color",
      "value": "Blue"
    },
    {
      "_id": "CqdFwGX3yitk9zf8z",
      "name": "Country",
      "variable": "country",
      "value": "US"
    }
  ],
  "createdAt": "2023-02-22 13:40:26 UTC",
  "requests": []
}