Add Contact

POST

POST

http://api.atzcrm.com/v1/contact

Create a new contact.

Request

Body

• first_namestring

  >= 1 characters (required)

• last_namestring

  >= 1 characters

• emailstring

  >= 1 characters

• phonestring

  >= 1 characters

• designationstring

  >= 1 characters

• stage_idinteger

  (required)

• owner_idinteger

  (required)

• descriptionstring

  >= 1 characters

• created_byinteger

• citystring

  >= 1 characters

• addressstring

  >= 1 characters

• xing_urlstring

  >= 1 characters

• linkedin_urlstring

  >= 1 characters

• tagsstring

  Allowed Comma-separated values:- [Java,Leadership]

• custom fields:Array[object]
  

  For Example:
  "id": 1,
  "value": "textfeild"

Response

201

Body

• idnumber

  Example: 28

• first_namestring

  Example: Anjali

• last_namestring

  Example: Kotwani

• slugstring

  Example: contact_68ba678fcd2a83f4640c

• full_namestring

  Example: Anjali Kotwani

• emailstring

  Example: anjali@gmail.com

• tagsstring

  Example: [frontend, developer, javascript]

• phonestring

  Example: +917489011449

• profile_picturestring

  Example: image.jpg

• designationstring

  Example: intern

• addressstring

  Example: rau bypass

• citystring

  Example: indore

• stageobject

  Example:
  "id": 1,
  "label": "lost"

• descriptionstring

  Example: Experienced software engineer with a focus on frontend development.

• organizationobject

  Example:
  "id": 1

• created_atstring (ISO 8601 date)

  Example: 2015-05-15T00:00:00Z

• updated_atstring (ISO 8601 date)

  Example: 2015-05-15T00:00:00Z

• created_byobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• updated_byobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• ownerobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• socialsobject

  Example:
  "linkedin": "anjalilinkedin.com",
  "xing": "anjali.com"

• custom fields:object

  Example:
  "id": 1,
  "field_name": "textfeild",
  "field_type": "string",
  "value": "anjali"

401

Body

• unauthorised

400

Body

• Unprocessable Entity

Response Example

{
    "id": 28,
    "first_name": "Anjali",
    "last_name": "Kotwani",
    "slug": "contact_68ba678fcd2a83f4640c",
    "full_name": "Anjali Kotwani",
    "email": "anjali@gmail.com",
    "tags": null,
    "phone": "+917489011449",
    "profile_picture": "",
    "designation": "",
    "address": "",
    "city": "",
    "stage": {
        "id": 1,
        "label": "Prospect"
    },
    "description": "",
    "organization": null,
    "created_at": "2024-08-10T17:57:52.000Z",
    "updated_at": "2024-08-11T11:49:27.000Z",
    "created_by": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "updated_by": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "owner": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "socials": {
        "linkedin": "",
        "xing": ""
    },
    "custom_fields": [
        {
            "id": 7,
            "field_name": "Drop",
            "field_type": "dropdown",
            "value": ""
        },
        {
            "id": 8,
            "field_name": "Multi",
            "field_type": "multiselect",
            "value": ""
        },
        {
            "id": 2,
            "field_name": "Percentage",
            "field_type": "percentage",
            "value": "0"
        }
    ]
}