API Reference / Statuses

POST /statuses

Create a new status

Creates a contact status. text (max 20 characters) and color are required, description (max 33) is optional. Admin only. color must be one of the allowed palette values; the system id is server-assigned.

Request body

  • idstringbson-id

    ID of the status

  • statusstring

    Type of the status

    enum: lead · prospect · customer · inactive · general · custom1 · custom2 · customX

  • textstringrequired

    Display text of the status

  • descriptionstring

    Longer description of what the status is for

  • colorstringhex-colorrequired

    The color of the status (six character hex value)

    enum: 666666 · 3399ff · cc0000 · f96600 · 000000 · ff00ff · 009900

  • countsintegerint32

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

  • total_countintegerint32

    Number of contacts the entire team owns, with the status

  • action_stream_countintegerint32

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

  • team_countsarray<object>

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

    array item fields →
    • user_idstringbson-id

      ID of the user

    • countsintegerint32

      Number of contacts the team member owns, with the status

Responses

201 Created
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • statusobject

      Values which help qualify where contacts are in the sales pipeline. The list of Statuses is already populated but it may be updated if needed, to better fit your organization.

      object fields →
      • idstringbson-id

        ID of the status

      • statusstring

        Type of the status

        enum: lead · prospect · customer · inactive · general · custom1 · custom2 · customX

      • textstringrequired

        Display text of the status

      • descriptionstring

        Longer description of what the status is for

      • colorstringhex-colorrequired

        The color of the status (six character hex value)

        enum: 666666 · 3399ff · cc0000 · f96600 · 000000 · ff00ff · 009900

      • countsintegerint32

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

      • total_countintegerint32

        Number of contacts the entire team owns, with the status

      • action_stream_countintegerint32

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

      • team_countsarray<object>

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

        array item fields →
        • user_idstringbson-id

          ID of the user

        • countsintegerint32

          Number of contacts the team member owns, with the status

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

Related guides