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" \
--data '{
"name": "Google",
"description": "Paid search on Google",
"position": 1,
"archived": false
}'
Request examples
{
"name": "Google",
"description": "Paid search on Google",
"position": 1,
"archived": false
}
Response examples (200)
[
{
"uuid": "79ada6f1-7224-485d-bb32-1476eaea8a8f",
"name": "Google",
"description": "Paid search on Google",
"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)
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."
]
}
}