Skip to main content
PATCH
/
api
/
agent
/
lead-magnets
/
{id}
Publish or archive lead magnet
curl --request PATCH \
  --url https://www.citedy.com/api/agent/lead-magnets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "type": "<string>",
  "topic": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "public_slug": "<string>",
  "public_url": "<string>",
  "pdf_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer citedy_agent_* key

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
status
enum<string>
required
Available options:
published,
archived

Response

Lead magnet updated

Returned when the lead magnet is completed, published, or archived.

​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
completed,
published,
archived
​
title
string
required
​
type
string
required
​
topic
string
required
​
created_at
string<date-time>
required
​
public_slug
string | null
​
public_url
string<uri> | null
​
pdf_url
string<uri> | null