Feature terms
List feature terms
- Base URL
https://api.polymorfa.com- Required permission
sessions:read
Returns published feature terms and this scope's acceptance. Pending terms have no text or acceptance requirement. Terms that cannot be activated yet stay pending even after publication. Accepting terms grants no feature access. Requires a team API key or a signed-in team member. Number scope IDs are Number resource UUIDs.
Query parameters
scopeKindstringCategory assigned to scope.
Allowed valuesteamprojectcustomernumberDefault"team"scopeIdstring (uuid)Required for project, customer and number scopes. Defaults to the authenticated team for team scope.
localestringSpecifies locale for this query parameter.
Allowed valuesenpt-BRDefault"en"
Responses
200Terms and acceptance state
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 1 child field
Show 3 headers
400Request refused
401Request refused
403Request refused
404Request refused
409Request refused
413Request refused
500Request refused
503Request refused
curl "https://api.polymorfa.com/platform/feature-terms" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"items": [
{
"key": "string",
"title": "string",
"scope": {
"kind": "team",
"id": "00000000-0000-4000-8000-000000000000"
},
"allowedScopes": [
"team"
],
"waiver": {
"type": "none",
"trigger": "none",
"days": 0
},
"termsUrl": "string",
"publication": "pending",
"current": {
"version": "string",
"textDigest": "string",
"locale": "en",
"terms": "string",
"withdrawal": "string",
"settingRevision": 0,
"publishedAt": "string"
},
"accepted": true,
"acceptance": {
"id": "00000000-0000-4000-8000-000000000000",
"action": "accept",
"version": "string",
"acceptedAt": "string",
"withdrawnAt": "string",
"evidence": "explicit"
}
}
]
}
}Accept feature terms
- Base URL
https://api.polymorfa.com- Required permission
sessions:manage
Records the exact published version, locale and text digest for this scope. Requires a team API key with sessions:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. Staff cannot accept for a customer. A repeated acceptance returns the existing record. This does not turn the feature on.
Path parameters
keystringrequiredpattern^[a-z][a-z0-9.-]{0,127}$Specifies key for this path parameter.
Body
scopeobjectrequiredStructured scope values for this schema.
Show 2 child fields
versionstringrequiredlength1–100Specifies version for this schema.
textDigeststringrequiredpattern^[a-f0-9]{64}$Specifies text digest for this schema.
localestringrequiredSpecifies locale for this schema.
Allowed valuesenpt-BR
Responses
200Acceptance recorded
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 6 child fields
Show 3 headers
400Request refused
401Request refused
403Request refused
404Request refused
409terms_acceptance_required: the text is unpublished or the version, locale or digest changed. Read the current terms before accepting. terms_activation_blocked: these terms cannot be accepted yet.
413Request refused
500Request refused
503Request refused
curl -X POST "https://api.polymorfa.com/platform/feature-terms/<key>/accept" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"scope": {
"kind": "team",
"id": "00000000-0000-4000-8000-000000000000"
},
"version": "string",
"textDigest": "string",
"locale": "en"
}'{
"success": true,
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"action": "accept",
"version": "string",
"acceptedAt": "string",
"withdrawnAt": "string",
"evidence": "explicit"
}
}Withdraw feature terms
- Base URL
https://api.polymorfa.com- Required permission
sessions:manage
Appends a withdrawal without changing the acceptance record. Requires a team API key with sessions:manage, or a signed-in team owner or admin. Preview enrollment terms require a signed-in team owner or admin. No current terms are required. Repeated withdrawals return the existing record; no previous acceptance returns null. Preview Contacts/Chats withdrawals reconcile capture before success; 503 service_unavailable means the withdrawal is recorded but capture is pending. Retrying the same withdrawal is safe. Other features must also be turned off through their settings to stop their work.
Path parameters
keystringrequiredpattern^[a-z][a-z0-9.-]{0,127}$Specifies key for this path parameter.
Body
scopeobjectrequiredStructured scope values for this schema.
Show 2 child fields
Responses
200Acceptance withdrawn
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequirednullableStructured data carried by this object.
Show 6 child fields
Show 3 headers
400Request refused
401Request refused
403Request refused
404Request refused
409terms_activation_blocked: these terms cannot be withdrawn yet. Change the feature through its settings.
413Request refused
500Request refused
503Request refused
curl -X POST "https://api.polymorfa.com/platform/feature-terms/<key>/withdraw" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"scope": {
"kind": "team",
"id": "00000000-0000-4000-8000-000000000000"
}
}'{
"success": true,
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"action": "accept",
"version": "string",
"acceptedAt": "string",
"withdrawnAt": "string",
"evidence": "explicit"
}
}