Update or archive a custom subtype. Requires agency or account admin role.

http
PUT https://services.leadconnectorhq.com/conversations/preferences/custom-subtypes/{id}

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
idstringYesve9EPM428h8vShlRW1KTCustom Subtype Id

Query parameters

NameTypeRequiredExampleDescription
locationIdstringYesve9EPM428h8vShlRW1KTAccount Id

Body

NameTypeRequiredExampleDescription
namestringNoNewsletter SubscriptionName of the custom subtype (max 100 characters)
descriptionstringNoUpdated weekly newsletter subscription preferencesDescription of the custom subtype (max 100 characters)
archivedbooleanNoFalseWhether the custom subtype is archived
resubscription_legal_form_idstringNoform_123456Resubscription legal form ID (optional when archiving)

Responses

200 - Response
400 - Bad Request
json
{}
401 - Unauthorized
json
{}

Example

curl -X PUT 'https://services.leadconnectorhq.com/conversations/preferences/custom-subtypes/YOUR_id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Newsletter Subscription",
  "description": "Updated weekly newsletter subscription preferences",
  "archived": false,
  "resubscription_legal_form_id": "form_123456"
}'

Last updated October 26, 2026

Was this page helpful?