Update a lead source Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
PUT /api/v1/lead-sources/{uuid}
Personal access token & O auth2

Path parameters

  • uuid string Required
application/json

Body

  • name string

    Name of the lead source. Must be unique within the firm.

    Maximum length is 255.

  • description string | null

    Optional description of the lead source.

  • position integer

    New position within the firm's list. Other lead sources shift to keep positions contiguous.

    Minimum value is 1.

  • archived boolean

    Archive or unarchive the lead source. Archived lead sources are hidden from the default list.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string
    • name string
    • description string
    • position integer
    • archived boolean
    • created_at string
    • updated_at string
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
PUT /api/v1/lead-sources/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/lead-sources/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "name": "Website",
  "description": "Enquiries via the contact page",
  "position": 1,
  "archived": false
}'
Request examples 
{
  "name": "Website",
  "description": "Enquiries via the contact page",
  "position": 1,
  "archived": false
}
Response examples (200) 
[
  {
    "uuid": "bdd74633-1f95-45b9-bcd8-41e614b7b146",
    "name": "Website",
    "description": "Enquiries via the contact page",
    "position": 1,
    "archived": false,
    "created_at": "2026-10-12T11:34:44+01:00",
    "updated_at": "2026-10-12T11:34:44+01:00"
  }
]
Response examples (422) 
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}
{
  "message": "The name has already been taken.",
  "errors": {
    "name": [
      "The name has already been taken."
    ]
  }
}
{
  "message": "The name must not be greater than 255 characters.",
  "errors": {
    "name": [
      "The name must not be greater than 255 characters."
    ]
  }
}
{
  "message": "The position must be at least 1.",
  "errors": {
    "position": [
      "The position must be at least 1."
    ]
  }
}
{
  "message": "The archived field must be true or false.",
  "errors": {
    "archived": [
      "The archived field must be true or false."
    ]
  }
}