Skip to main content
PATCH
/
api
/
v2
/
crm
/
lists
/
{list_id}
Update CRM list
curl --request PATCH \
  --url https://api.topyappers.com/api/v2/crm/lists/{list_id} \
  --header 'Content-Type: application/json' \
  --header 'x-ty-api-key: <api-key>' \
  --data '
{
  "name": "June outreach - priority",
  "description": "Priority creators for June campaign"
}
'
{
  "message": "OK",
  "response": {
    "id": "<string>",
    "name": "<string>",
    "website_id": "<string>",
    "description": "<string>",
    "budget": 123,
    "start_date": "<string>",
    "end_date": "<string>",
    "team_id": "<string>",
    "active": true,
    "contact_count": 123,
    "to_outreach_count": 123,
    "date_created": "<string>",
    "date_updated": "<string>"
  }
}

Authorizations

x-ty-api-key
string
header
required

Path Parameters

list_id
string
required

CRM list ID.

Body

application/json
name
string

CRM list name.

Required string length: 1 - 120
websiteId
string | null
description
string | null
budget
number | null
Required range: x >= 0
startDate
string<date-time> | null
endDate
string<date-time> | null

Response

CRM list updated

message
string
Example:

"OK"

response
object