Sign in
CRM

Api to create an allocation to a user or common pool

post/crm/allocation

Query parameters

isCommonPoolboolean
Example:true

When isCommonPool is true, if the assignTo number is missing or invalid, the allocation will be uploaded into common pool

Request body

priority3 | 2 | 1 | -1 nullable

Priority of the customer. 3 -> HIGH, 2 -> MEDIUM, 1 -> LOW, -1 -> NOT MENTIONED

notesstring nullable

Remarks given by the user

processNamestring nullable

Process name in which this lead should be assigned

ruleNamestring nullable

Allocation rule name based on which this lead is being assigned

assignedTostring required

Phone number of the user to which this allocation should be assigned. Phone number should have country code in it

Example request

{
  "customer": {
    "name": "Rohit Agarwal",
    "phoneNumber": "+919898989898",
    "email": "rohit.agarwal@gmail.com",
    "company": {
      "name": "Agarwal Foods Limited",
      "address": {
        "street": "84-2, Main road",
        "city": "RAIPUR",
        "state": "Chattisgarh",
        "country": "India",
        "pincode": 578100
      },
      "kdm": {
        "name": "Varun Agarwal",
        "phoneNumber": "+919696969696"
      }
    }
  },
  "priority": 3,
  "notes": "Customer is interested and asked to drop details on mail. Scheduling a followup with Priyank to take the discussion forward",
  "processName": "Default Process",
  "assignedTo": "+919876543210",
  "ruleName": "Default",
  "userFields": [
    {
      "name": "source",
      "value": "Referral"
    },
    {
      "name": "status",
      "value": "Cold Followup"
    },
    {
      "name": "Followup On",
      "value": 1603171442
    }
  ]
}

Response

If the auth token is valid.

messagestring
statusCodenumber

Example response

{
  "message": "Successfully added the allocation"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.