Skip to main content
POST
/
api
/
contact
Create contact
curl --request POST \
  --url https://your-instance.example.com/api/contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "process": "<string>",
  "status": "<string>",
  "pipelineStage": "<string>",
  "pipelineId": "<string>"
}
'
{
  "success": true,
  "data": {
    "contact": {
      "_id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "status": "<string>",
      "pipelineId": "<string>",
      "pipelineStage": "<string>",
      "organizationId": "<string>",
      "userId": "<string>",
      "createdBy": "<string>",
      "assignees": [
        "<unknown>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "message": "<string>"
  },
  "message": "<string>",
  "contact": {
    "_id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "status": "<string>",
    "pipelineId": "<string>",
    "pipelineStage": "<string>",
    "organizationId": "<string>",
    "userId": "<string>",
    "createdBy": "<string>",
    "assignees": [
      "<unknown>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
phoneNumber
string
required
firstName
string
lastName
string
email
string<email>
process
string
status
string
pipelineStage
string
pipelineId
string

Response

Contact created

success
enum<boolean>
required
Available options:
true
data
object
required
message
string
contact
object