Chatofy API

/

Getting Started

API Resources

API v1.0 Live

Developer APIContactsCreate Contact

Create Contact

Creates a new contact. Only phone_number is required. Custom properties go inside the attributes JSON object.

POST/api/v1/contact/create

Request Body Schema

application/json

phone_numberstringrequired

Contact phone number with country code (e.g. +919000000000)

Example:+919000000000

first_namestringoptional

Contact first name

Example:Jane

last_namestringoptional

Contact last name

emailstringoptional

Validated lowercase email address

Example:[email protected]

addressstringoptional

Street address or office location

Example:123 Marine Drive

companystringoptional

Company name

Example:Acme Corp

citystringoptional

City

Example:Mumbai

statestringoptional

State or province

Example:Maharashtra

countrystringoptional

2-letter ISO 3166-1 alpha-2 country code

Example:IN

sourcestringoptional

Lead generation source

Example:website_form

platformstringoptional

Platform stage: no_account, trial, paid, trial_ended (default: no_account)

Example:trial

owner_iduuidoptional

Assigned user UUID

marketing_opt_inbooleanoptional

Marketing opt-in status (default: false)

Example:true

opt_in_sourcestringoptional

Opt-in source (e.g. signup_checkbox)

lifecyclestringoptional

Contact lifecycle: lead, customer, at_risk, churned (default: lead)

Example:lead

attributesobjectoptional

Custom key-value properties

Example:{"tier": "gold"}

Response Payload

200 OKapplication/json

successbooleanrequired

Whether request succeeded

data.contact.iduuidrequired

Newly created contact UUID

data.contact.phone_numberstringrequired

Phone number

data.contact.first_namestringoptional

First name

data.contact.attributesobjectoptional

Custom fields

data.contact.created_atdatetimerequired

Creation timestamp

Code Snippets & Examples

1	curl -X POST "https://app.chatofy.in/api/v1/contact/create" \
2	-H "Authorization: Bearer YOUR_API_KEY" \
3	-H "Content-Type: application/json" \
4	-d '{"phone_number":"+919000000000","first_name":"Jane","attributes":{"email":"[email protected]"}}'

Was this endpoint guide helpful?

1	curl -X POST "https://app.chatofy.in/api/v1/contact/create" \
2	-H "Authorization: Bearer YOUR_API_KEY" \
3	-H "Content-Type: application/json" \
4	-d '{"phone_number":"+919000000000","first_name":"Jane","attributes":{"email":"[email protected]"}}'

200 OKapplication/json

1	{
2	"success": true,
3	"data": {
4	"contact": {
5	"id": "d9b23f28-0db4-4054-9720-6d4b97ce26bb",
6	"phone_number": "919000000000",
7	"display_name": "Jane",
8	"first_name": "Jane",
9	"last_name": null,
10	"email": "[email protected]",
11	"address": "123 Marine Drive",
12	"company": "Acme Corp",
13	"city": "Mumbai",
14	"state": "Maharashtra",
15	"country": "IN",
16	"source": "website_form",
17	"platform": "trial",
18	"owner_id": null,
19	"marketing_opt_in": true,
20	"opt_in_at": "2026-06-06T12:11:59+05:30",
21	"opt_in_source": "signup_checkbox",
22	"lifecycle": "lead",
23	"lifecycle_changed_at": "2026-06-06T12:11:59+05:30",
24	"attributes": {
25	"tier": "gold"
26	},
27	"created_at": "2026-06-06T12:11:59+05:30",
28	"updated_at": "2026-06-06T12:11:59+05:30"
29	}
30	},
31	"message": "Contact created successfully"
32	}

Chatofy API

/

Getting Started

API Resources

API v1.0 Live

Developer APIContactsCreate Contact

Create Contact

Creates a new contact. Only phone_number is required. Custom properties go inside the attributes JSON object.

POST/api/v1/contact/create

Request Body Schema

application/json

phone_numberstringrequired

Contact phone number with country code (e.g. +919000000000)

Example:+919000000000

first_namestringoptional

Contact first name

Example:Jane

last_namestringoptional

Contact last name

emailstringoptional

Validated lowercase email address

Example:[email protected]

addressstringoptional

Street address or office location

Example:123 Marine Drive

companystringoptional

Company name

Example:Acme Corp

citystringoptional

City

Example:Mumbai

statestringoptional

State or province

Example:Maharashtra

countrystringoptional

2-letter ISO 3166-1 alpha-2 country code

Example:IN

sourcestringoptional

Lead generation source

Example:website_form

platformstringoptional

Platform stage: no_account, trial, paid, trial_ended (default: no_account)

Example:trial

owner_iduuidoptional

Assigned user UUID

marketing_opt_inbooleanoptional

Marketing opt-in status (default: false)

Example:true

opt_in_sourcestringoptional

Opt-in source (e.g. signup_checkbox)

lifecyclestringoptional

Contact lifecycle: lead, customer, at_risk, churned (default: lead)

Example:lead

attributesobjectoptional

Custom key-value properties

Example:{"tier": "gold"}

Response Payload

200 OKapplication/json

successbooleanrequired

Whether request succeeded

data.contact.iduuidrequired

Newly created contact UUID

data.contact.phone_numberstringrequired

Phone number

data.contact.first_namestringoptional

First name

data.contact.attributesobjectoptional

Custom fields

data.contact.created_atdatetimerequired

Creation timestamp

Code Snippets & Examples

1	curl -X POST "https://app.chatofy.in/api/v1/contact/create" \
2	-H "Authorization: Bearer YOUR_API_KEY" \
3	-H "Content-Type: application/json" \
4	-d '{"phone_number":"+919000000000","first_name":"Jane","attributes":{"email":"[email protected]"}}'

Was this endpoint guide helpful?

1	curl -X POST "https://app.chatofy.in/api/v1/contact/create" \
2	-H "Authorization: Bearer YOUR_API_KEY" \
3	-H "Content-Type: application/json" \
4	-d '{"phone_number":"+919000000000","first_name":"Jane","attributes":{"email":"[email protected]"}}'

200 OKapplication/json

1	{
2	"success": true,
3	"data": {
4	"contact": {
5	"id": "d9b23f28-0db4-4054-9720-6d4b97ce26bb",
6	"phone_number": "919000000000",
7	"display_name": "Jane",
8	"first_name": "Jane",
9	"last_name": null,
10	"email": "[email protected]",
11	"address": "123 Marine Drive",
12	"company": "Acme Corp",
13	"city": "Mumbai",
14	"state": "Maharashtra",
15	"country": "IN",
16	"source": "website_form",
17	"platform": "trial",
18	"owner_id": null,
19	"marketing_opt_in": true,
20	"opt_in_at": "2026-06-06T12:11:59+05:30",
21	"opt_in_source": "signup_checkbox",
22	"lifecycle": "lead",
23	"lifecycle_changed_at": "2026-06-06T12:11:59+05:30",
24	"attributes": {
25	"tier": "gold"
26	},
27	"created_at": "2026-06-06T12:11:59+05:30",
28	"updated_at": "2026-06-06T12:11:59+05:30"
29	}
30	},
31	"message": "Contact created successfully"
32	}