👥Contacts

Create/Update/Get contacts within your tenant.

Create contact

POST https://app.ninjapipe.com/api/v1/contacts/create

Creates a new contact in your workspace.

Make sure to add API_KEY as a header. This is your API Key found in the API & Integrations page.

Request Body

Create Contact

post

/api/v1/contacts/create

Authorizations

Header parameters

API_KEYstring

Example: API_KEY

Body

object

Example: {"category":"Lead","first_name":"Display","last_name":"Picture","picture_url":"https://cdn.pixabay.com/photo/2016/08/08/09/17/avatar-1577909_1280.png","email":"[e-mail]","organization":"Example Corp.","phone":null,"address":"123 Main St.","state":"CA","zip_code":"12345","country":"USA","timezone":"America/Los_Angeles","currency":"USD","industry":"Technology","company_size":"100-500","position":"CEO","revenue":"10M-50M","mrr":"100K-500K","churn":"5%","lead_source":"Website","lead_status":"New","instagram":"johndoe","tiktok":"johndoe","facebook":"johndoe","twitter":"johndoe","linkedIn":"testin","by_phone":true,"by_email":true,"by_text":false,"by_social":true}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.ninjapipe.com/api/v1/contacts/create' \
  --header 'Authorization: noauth YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"category":"Lead","first_name":"Display","last_name":"Picture","picture_url":"https://cdn.pixabay.com/photo/2016/08/08/09/17/avatar-1577909_1280.png","email":"[e-mail]","organization":"Example Corp.","phone":null,"address":"123 Main St.","state":"CA","zip_code":"12345","country":"USA","timezone":"America/Los_Angeles","currency":"USD","industry":"Technology","company_size":"100-500","position":"CEO","revenue":"10M-50M","mrr":"100K-500K","churn":"5%","lead_source":"Website","lead_status":"New","instagram":"johndoe","tiktok":"johndoe","facebook":"johndoe","twitter":"johndoe","linkedIn":"testin","by_phone":true,"by_email":true,"by_text":false,"by_social":true}'

200

200

No body

Successful response

Update a contact

PUThttps://app.ninjapipe.com/api/v1/contacts/{contact_id}/update

Update Contact

put

/api/v1/contacts/15857/update

Authorizations

Header parameters

API_KEYstring

Example: API_KEY

Body

object

Example: {"category":"Nurtured","first_name":"Display","last_name":"Picture","picture_url":"https://cdn.pixabay.com/photo/2016/08/08/09/17/avatar-1577909_1280.png","email":"[e-mail]","organization":"Example Corp.","address":"123 Main St.","state":"CA","zip_code":"12345","country":"USA","timezone":"America/Los_Angeles","currency":"USD","industry":"Technology","company_size":"100-500","position":"CEO","revenue":"10M-50M","mrr":"100K-500K","churn":"5%","lead_source":"Website","lead_status":"New","instagram":"johndoe","tiktok":"johndoe","facebook":"johndoe","twitter":"johndoe","linkedIn":"testin","by_phone":true,"by_email":true,"by_text":false,"by_social":true,"has_client_portal":false,"company_phone":null,"whatsapp":null,"phone_code":"0","account_type":"client","phone":""}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.ninjapipe.com/api/v1/contacts/15857/update' \
  --header 'Authorization: noauth YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"category":"Nurtured","first_name":"Display","last_name":"Picture","picture_url":"https://cdn.pixabay.com/photo/2016/08/08/09/17/avatar-1577909_1280.png","email":"[e-mail]","organization":"Example Corp.","address":"123 Main St.","state":"CA","zip_code":"12345","country":"USA","timezone":"America/Los_Angeles","currency":"USD","industry":"Technology","company_size":"100-500","position":"CEO","revenue":"10M-50M","mrr":"100K-500K","churn":"5%","lead_source":"Website","lead_status":"New","instagram":"johndoe","tiktok":"johndoe","facebook":"johndoe","twitter":"johndoe","linkedIn":"testin","by_phone":true,"by_email":true,"by_text":false,"by_social":true,"has_client_portal":false,"company_phone":null,"whatsapp":null,"phone_code":"0","account_type":"client","phone":""}'

200

200

No body

Successful response

GEThttps://app.ninjapipe.com/api/v1/contacts/get?contact_id={contact_id}

Get Contact

get

/api/v1/contacts/get

Authorizations

Query parameters

contact_idinteger

Example: 15857

Header parameters

API_KEYstring

Example: API_KEY

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.ninjapipe.com/api/v1/contacts/get' \
  --header 'Authorization: noauth YOUR_SECRET_TOKEN'

200

200

No body

Successful response

Get all contacts

GEThttps://app.ninjapipe.com/v1/contacts/getall

Parameters:

• only_body = true - This will send the body without the status/content/message format

• page - You can paginate with this parameter starting from 0. Increment and send this to fetch pages

• rows_per_page - You can define how many contacts will be returned with each page above

Get contact

Get Contacts

get

/api/v1/contacts/getall

Authorizations

Query parameters

only_bodyboolean

Example: false

Header parameters

API_KEYstring

Example: API_KEY

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.ninjapipe.com/api/v1/contacts/getall' \
  --header 'Authorization: noauth YOUR_SECRET_TOKEN'

200

200

No body

Successful response

Search contact

You can search for contacts using the following API.

GEThttps://app.ninjapipe.com/api/v1/contacts/search?search_term=YOUR_KEYWORD

Parameters:

• search_term - Send any keyword you'd like to search. The search API matches first and last names, emails and phone numbers.

• only_body - Sends only the body of the result and avoids the status and message in the response

Delete contact

Currently, deleting a contact is not supported via the API. You may use the web or mobile platform to initiate a contact deletion

Add Comment

Add a comment to a contact.

POST https://app.ninjapipe.com/v1/pipelines/add-comment

Request Body

{
    "comment_text": "Test comment from API",
    "module_type": "contact", //hardcode this
    "module_id": 123 //contact's ID
}

Headers

• API_KEY