TextKitDocs

Update a list

PATCH/v1/lists/{id}

Path Parameters

  • idstringrequired

Body Parameters

  • namestring

    At most 80 characters. Example: Spring promo.

  • descriptionstring

    At most 200 characters. Nullable.

Responses

  • 200List

    The list

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404Error

    Not found

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • idstring

    Example: lst_a1B2c3D4e5F6.

  • objectlist
  • namestring

    Example: Spring promo.

  • descriptionstring

    Nullable.

  • integration_idstring

    Set when an integration sync owns the list Nullable.

  • contact_countinteger
  • created_atstring (date-time)
  • updated_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 404

    Not found

  • 429

    Rate limit or quota exceeded