API Reference / Lead Sources

PUT /lead_sources/{lead_source_id}

Update a specific lead source

Updates a lead source's text (max 40 characters). Admin only. text is the only field; it is required unless you pass partial=true, which leaves the current value unchanged when omitted. The list is re-sorted alphabetically afterwards.

Path parameters

Name Type Description
lead_source_id req string Lead Source ID

Request body

  • idstring

    ID of the lead source

  • textstringrequired

    Description of the lead source

  • countsintegerint32

    Number of contacts the (logged API) user owns, with the lead source

  • total_countintegerint32

    Number of contacts the entire team owns, with the lead source

  • action_stream_countintegerint32

    Number of contacts the (logged API) user has actions with, who also have the lead source

  • team_countsarray<object>

    Number of contacts, with the lead source (for each team member)

    array item fields →
    • user_idstringbson-id

      ID of the user

    • countsintegerint32

      Number of contacts the team member owns, with the lead source

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject

    A way to classify the source of any contact that is added to OnePageCRM. Like Statuses, this list is pre-populated, and can be later edited to fit individual needs.

    object fields →
    • idstring

      ID of the lead source

    • textstringrequired

      Description of the lead source

    • countsintegerint32

      Number of contacts the (logged API) user owns, with the lead source

    • total_countintegerint32

      Number of contacts the entire team owns, with the lead source

    • action_stream_countintegerint32

      Number of contacts the (logged API) user has actions with, who also have the lead source

    • team_countsarray<object>

      Number of contacts, with the lead source (for each team member)

      array item fields →
      • user_idstringbson-id

        ID of the user

      • countsintegerint32

        Number of contacts the team member owns, with the lead source

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides