Contacts

GetContactByEmailV1

get

Get a contact by email from public api

Path parameters

emailstringRequired

the email

Responses

200

success

application/json

httpStatusintegerOptional

messagestringOptional

get

/v1/contacts/{email}

HTTPcURLJavaScriptPython

GET /api/v1/contacts/{email} HTTP/1.1
Host: pub-api.conversion.ai
Accept: */*

200

success

{
  "data": {
    "companyId": "text",
    "createdAt": "text",
    "email": "text",
    "id": "text",
    "subscriptionStatus": "text",
    "syncToCrm": true,
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "httpStatus": 1,
  "message": "text"
}

DeleteContactByEmailV1

delete

Delete a contact by email from public api

Path parameters

emailstringRequired

the email

Query parameters

gdprbooleanOptional

whether to delete the recipient if gdpr is true

Responses

200

success

application/json

databooleanOptional

If success data is populated otherwise it's empty

httpStatusintegerOptional

messagestringOptional

delete

/v1/contacts/{email}

HTTPcURLJavaScriptPython

DELETE /api/v1/contacts/{email} HTTP/1.1
Host: pub-api.conversion.ai
Accept: */*

200

success

{
  "data": true,
  "httpStatus": 1,
  "message": "text"
}

BatchUpsertContactsV1

post

Batch upsert contacts from public api

Body

application/json

Responses

200

success

application/json

databooleanOptional

If success data is populated otherwise it's empty

httpStatusintegerOptional

messagestringOptional

post

/v1/contacts/batch

HTTPcURLJavaScriptPython

POST /api/v1/contacts/batch HTTP/1.1
Host: pub-api.conversion.ai
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "batch": [
    {
      "companyId": "text",
      "createdAt": "text",
      "email": "text",
      "id": "text",
      "subscriptionStatus": "text",
      "syncToCrm": true,
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

200

success

{
  "data": true,
  "httpStatus": 1,
  "message": "text"
}