Update a sub-source of a lead source Run in API Explorer
Ask AI
Body
-
Name of the sub-source. Must be unique within its lead source.
Maximum length is
255. -
Optional description of the sub-source.
-
New position within the lead source's list. Other sub-sources shift to keep positions contiguous.
Minimum value is
1. -
Archive or unarchive the sub-source. Archived sub-sources are hidden from the default list.
PUT
/api/v1/lead-sources/{lead_source_uuid}/sub-sources/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/lead-sources/6ff8f7f6-1eb3-3525-be4a-3932c805afed/sub-sources/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{
"name": "Google",
"description": "Paid search on Google",
"position": 1,
"archived": false
}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"name": "Google",
"description": "Paid search on Google",
"position": 1,
"archived": false
}
Response examples (200)
{
"uuid": "b4ee4033-8f3c-458e-b11d-44da7b22e2e2",
"name": "Google",
"description": "Paid search on Google",
"position": 1,
"archived": false,
"lead_source": {
"uuid": "bcd7cc74-ab44-4cef-a1d9-91d606b7d3d2",
"name": "Website",
"description": "Enquiries via the contact page",
"position": 1,
"archived": false,
"sub_sources": {
"uuid": "f8b9021a-3667-4f20-88cd-548c42d0e61b",
"name": "Google",
"description": "Paid search on Google",
"position": 1,
"archived": false,
"created_at": "2026-11-20T16:36:35+00:00",
"updated_at": "2026-11-20T16:36:35+00:00"
},
"created_at": "2026-11-20T16:36:29+00:00",
"updated_at": "2026-11-20T16:36:29+00:00"
},
"created_at": "2026-11-20T16:36:29+00:00",
"updated_at": "2026-11-20T16:36:29+00:00"
}
Response examples (422)
Blank name
{
"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."
]
}
}