{"id":4336,"date":"2025-02-26T12:27:47","date_gmt":"2025-02-26T10:27:47","guid":{"rendered":"https:\/\/modulus.help\/kb\/?post_type=docs&p=4336"},"modified":"2025-02-26T12:31:06","modified_gmt":"2025-02-26T10:31:06","slug":"api-entity-create","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/contacts-apis-v1\/api-entity-create\/","title":{"rendered":"API: Entity Create"},"content":{"rendered":"\n

The purpose of this API is to Create an entity.<\/p>\n\n\n\n

Request<\/h4>\n\n\n\n\n\n\n\n\n\n\n
\n
URL<\/div>\n<\/th>\n
\n
https:\/\/your_account.modulus.biz\/api\/cnt\/entity?token=YOUR_TOKEN<\/div>\n<\/td>\n<\/tr>\n
\n
API Name<\/div>\n<\/th>\n
\n
entity<\/div>\n<\/td>\n<\/tr>\n
\n
Method<\/div>\n<\/th>\n
\n
POST<\/div>\n<\/td>\n<\/tr>\n
\n
Source<\/div>\n<\/th>\n
\n
Third Party Server<\/div>\n<\/td>\n<\/tr>\n
\n
Recipient<\/div>\n<\/th>\n
\n
modulus\u00ae Server<\/div>\n<\/td>\n<\/tr>\n
\n
Content Type<\/div>\n<\/th>\n
\n
application\/json<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Query String Parameters<\/h4>\n\n\n\n\n\n\n\n
\n
Parameter<\/div>\n<\/th>\n
\n
Required<\/div>\n<\/th>\n
\n
Type<\/div>\n<\/th>\n
\n
Description<\/div>\n<\/th>\n<\/tr>\n<\/thead>\n
\n
token<\/div>\n<\/th>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Your authentication token.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Payload Parameters<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n
\n
Parameter<\/div>\n<\/th>\n
\n
Required<\/div>\n<\/th>\n
\n
Type<\/div>\n<\/th>\n
\n
Description<\/div>\n<\/th>\n<\/tr>\n<\/thead>\n
\n
code<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Entity code<\/div>\n<\/td>\n<\/tr>\n
\n
name<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Entity name<\/div>\n<\/td>\n<\/tr>\n
\n
type<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Possible values:\u00a0individual, organization.<\/div>\n<\/td>\n<\/tr>\n
\n
tag<\/strong><\/div>\n<\/td>\n
\n
No<\/div>\n<\/td>\n
\n
Array<\/div>\n<\/td>\n
\n
Possible values: customer, supplier, lead.<\/div>\n<\/td>\n<\/tr>\n
\n
address<\/div>\n<\/th>\n
\n
No<\/div>\n<\/td>\n
\n
Object<\/div>\n<\/td>\n
\n
Attach the address to this entity.<\/div>\n<\/td>\n<\/tr>\n
\n
contact<\/div>\n<\/th>\n
\n
No<\/div>\n<\/td>\n
\n
Object<\/div>\n<\/td>\n
\n
Attach the contact to this entity.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Address parameter details<\/h4>\n\n\n\n\n\n\n\n\n\n\n
\n
Parameter<\/div>\n<\/th>\n
\n
Required<\/div>\n<\/th>\n
\n
Type<\/div>\n<\/th>\n
\n
Description<\/div>\n<\/th>\n<\/tr>\n<\/thead>\n
\n
Label<\/div>\n<\/th>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Address label up to 255 character.<\/div>\n<\/td>\n<\/tr>\n
\n
country_code<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Up to 3 character string.<\/div>\n<\/td>\n<\/tr>\n
\n
city<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Name of the city inside the country.<\/div>\n<\/td>\n<\/tr>\n
\n
address<\/div>\n<\/th>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Full address string.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Contact parameter details<\/h4>\n\n\n\n\n\n\n\n\n\n
\n
Parameter<\/div>\n<\/th>\n
\n
Required<\/div>\n<\/th>\n
\n
Type<\/div>\n<\/th>\n
\n
Description<\/div>\n<\/th>\n<\/tr>\n<\/thead>\n
\n
type<\/div>\n<\/th>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
possible values: mobile, phone, email, fax, website, other.<\/div>\n<\/td>\n<\/tr>\n
\n
label<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Contact label up to 255 character.<\/div>\n<\/td>\n<\/tr>\n
\n
value<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Contact value up to 255 character.<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Responses<\/h4>\n\n\n\n\n\n\n\n\n\n\n
\n
HTTP Status<\/div>\n<\/th>\n
\n
result<\/div>\n<\/th>\n
\n
title<\/div>\n<\/th>\n
\n
message<\/div>\n<\/th>\n
\n
object<\/div>\n<\/th>\n<\/tr>\n<\/thead>\n
\n
Success Responses<\/div>\n<\/th>\n<\/tr>\n
\n
200 OK<\/div>\n<\/td>\n
\n
true<\/div>\n<\/td>\n
\n
Success<\/div>\n<\/td>\n
\n
Entity created successfully.<\/div>\n<\/td>\n
\n
\u00a0<\/div>\n<\/td>\n<\/tr>\n
\n
Failure Responses<\/div>\n<\/th>\n<\/tr>\n
\n
500 Internal Server Error<\/div>\n<\/td>\n
\n
false<\/div>\n<\/td>\n
\n
Error<\/div>\n<\/td>\n
\n
Error message describe the problem.<\/div>\n<\/td>\n
\n
\u00a0<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Example<\/h4>\n\n\n\n\n\n\n
\n
Request<\/div>\n<\/th>\n
\n
curl --request POST 'https:\/\/your_account.modulus.biz\/api\/cnt\/entity?token=YOUR_TOKEN' \\ --header 'Content-Type: application\/json' \\ <\/code>
--data\u00a0'{
\u00a0\u00a0\u00a0\u00a0\"code\":\"c1\",
\u00a0\u00a0\u00a0\u00a0\"name\":\"api_entity\",
\u00a0\u00a0\u00a0\u00a0\"type\":\"individual\",
\u00a0\u00a0\u00a0\u00a0\"tag\":\"lead\",
\u00a0\u00a0\u00a0\u00a0\"address\":{
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"label\":\"home\",
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"country_code\":\"eg\",
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"city\":\"moqattam\",
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"address\":\"street\u00a0123\"
\u00a0\u00a0\u00a0\u00a0},
\u00a0\u00a0\u00a0\u00a0\"contact\":{
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"type\":\"mobile\",
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"label\":\"iphone\",
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"value\":\"123123123\"
\u00a0\u00a0\u00a0\u00a0}
}'<\/code><\/div>\n<\/td>\n<\/tr>\n
\n
200 OK<\/div>\n<\/th>\n
\n
{ \"result\": true, \"title\": \"Success\", \"message\": \"Entity created successfully.\"}<\/code><\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","protected":false},"featured_media":0,"parent":4335,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4336"}],"collection":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/comments?post=4336"}],"version-history":[{"count":3,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4336\/revisions"}],"predecessor-version":[{"id":4406,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4336\/revisions\/4406"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4335"}],"wp:attachment":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/media?parent=4336"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=4336"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}