👥Contacts

Create/Update/Get contacts within your tenant.

Create contact

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

Creates a new contact in your tenant.

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

Request Body

Create Contact

POSThttps://app.ninjapipe.com/api/v1/contacts/create

Authorization

noauthAuth

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.ninjapipe.com/api/v1/contacts/create', {
    method: 'POST',
    headers: {
      "Authorization": "noauth <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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
    }),
});
const data = await response.json();

Update a contact

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

Update Contact

PUThttps://app.ninjapipe.com/api/v1/contacts/15857/update

Authorization

noauthAuth

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.ninjapipe.com/api/v1/contacts/15857/update', {
    method: 'PUT',
    headers: {
      "Authorization": "noauth <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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": ""
    }),
});
const data = await response.json();

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

Get Contact

GEThttps://app.ninjapipe.com/api/v1/contacts/get

Authorization

noauthAuth

Query parameters

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.ninjapipe.com/api/v1/contacts/get', {
    method: 'GET',
    headers: {
      "Authorization": "noauth <token>"
    },
});
const data = await response.json();

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

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

Authorization

noauthAuth

Query parameters

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.ninjapipe.com/api/v1/contacts/getall', {
    method: 'GET',
    headers: {
      "Authorization": "noauth <token>"
    },
});
const data = await response.json();

Search contact

You can search for contacts using the following API.

GEThttps://app.ninjapipe.com/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