Skip to main content
POST
/
workspaces
/
{workspace}
/
newsletters
/
{newsletter}
/
subscribe
Subscribe contact by contact_id
curl --request POST \
  --url https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "e7b8d2a2-4c3f-4a1e-9c2e-123456789abc",
  "status": true,
  "name": "John Doe",
  "email": "[email protected]",
  "custom_input_value": [
    {
      "id": 1,
      "value": "Some value"
    }
  ]
}
'
{
  "data": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace
string<uuid>
required

ID of the workspace.

​
newsletter
integer
required

The newsletter ID

Body

application/json
​
contact_id
string<uuid>
required

Existing contact ID

Example:

"e7b8d2a2-4c3f-4a1e-9c2e-123456789abc"

​
status
boolean
required

true = subscribed, false = unsubscribed

Example:

true

​
name
string | null
Example:

"John Doe"

​
email
string<email> | null
​
custom_input_value
object[]

Response

​
data
object
required