Add Organization

Add Organization

POST

Create a new organization.

Request

Body

• namestring

  >= 1 characters (required)

• websitestring

  >= 1 characters

• upsertboolean

  Optional. Default: false. Set to true to create a new organization or enrich an existing matching organization.

• match_byArray[string] or string

  Optional. Used only when upsert is true. Accepts an array of strings or a comma-separated string. Allowed values: website, linkedin_url, name. If omitted, all allowed values are used. Matching uses OR logic.

• Upsert details

  Use upsert when you want ATZ CRM to create an organization if no match exists, or enrich an existing matching organization if one is found.

  • If upsert is omitted or set to false, ATZ CRM creates a new organization.
  • If upsert is true, ATZ CRM searches using the selected match_by fields.
  • If a match is found, only empty fields on the existing organization are filled from the request. Existing non-empty fields are not overwritten.
  • If no match is found, ATZ CRM creates a new organization.

  Allowed match_by values: website, linkedin_url, name.

  Default matching: If upsert is true and match_by is not provided, ATZ CRM uses website, linkedin_url, and name.

  Matching works like an OR condition. If any one selected field matches an existing organization, that organization can be updated.

  Example:

  {
  "upsert": true,
  "match_by": ["website"],
  "name": "Acme Corp",
  "website": "https://www.acme.com",
  "location": "New York"
  }

• locationstring

  >= 1 characters

• addressstring

  >= 1 characters

• industry_idinteger

• descriptionstring

  >= 1 characters

• xing_urlstring

  >= 1 characters

• linkedin_urlstring

  >= 1 characters

• owner_idinteger

  (required)

• created_byinteger

• tagsstring

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

• custom fields:Array[object]
  

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

Response

201

Body

• idnumber

  Example: 28

• slugstring

  Example: organization_d1d6d8323f07a6615f95

• namestring

  Example: Anjali kotwani

• websitestring

  Example: google.com

• locationstring

  Example: indore

• Addressstring

  Example: pipariya

• tagsstring

  Example: [leader,java]

• industryobject

  Example:
  "id": 1,
  "name": "it",
  

• descriptionstring

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

• profile_picturestring

  Example: img.jpg

• ownerobject

  Example:
  "id": 17"

• 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

• updated_byobject

  Example:
  "id": 1

• 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": 6,
    "slug": "organization_931819e6d2e065d355ab",
    "name": "TEs contact ",
    "website": "",
    "location": "",
    "address": "",
    "tags": null,
    "industry": null,
    "description": "",
    "profile_picture": "",
    "owner": {
        "id": 1
    },
    "created_at": "2024-05-24T20:06:58.000Z",
    "updated_at": "2024-05-24T20:06:58.000Z",
    "created_by": {
        "id": 1
    },
    "updated_by": {
        "id": 1
    },
    "socials": {
        "linkedin": "",
        "xing": ""
    },
    "custom_fields": [
        {
            "id": 1,
            "field_name": "C Text asasa",
            "field_type": "text",
            "value": "Some custom value"
        },
        {
            "id": 2,
            "field_name": "C Date",
            "field_type": "date",
            "value": null
        }
    ]
}