Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

source_slug
string
required

The slug of the source

Body

Serializer mixin: relabels the actor as "Nekt Support" for customer-facing output when the row was produced during a support impersonation session.

Add to any serializer whose model is an ImpersonationAttributedModel and that exposes created_by and/or triggered_by. The real user stays in the DB and the real agent stays in the ImpersonationSession audit trail.

The API contract is preserved: an EXPANDED actor field returns the full "Nekt Support" object, while an UNEXPANDED one returns the NEKT_SUPPORT_ID sentinel string — same scalar-id vs object shape as a normal user. We never return the real user's id here (the frontend would resolve it against the org and surface the impersonated customer instead of "Nekt Support").

expires_in_seconds
integer
write-only
Required range: x >= 1
connector_config_fields
any | null

Restricts which connector config fields are visible/editable through this setup token. Null (the default) makes every field available, matching prior behavior. false hides a field (and its children); a list or object narrows availability to the named fields, recursing into their children with the same semantics.

Response

201 - application/json

Serializer mixin: relabels the actor as "Nekt Support" for customer-facing output when the row was produced during a support impersonation session.

Add to any serializer whose model is an ImpersonationAttributedModel and that exposes created_by and/or triggered_by. The real user stays in the DB and the real agent stays in the ImpersonationSession audit trail.

The API contract is preserved: an EXPANDED actor field returns the full "Nekt Support" object, while an UNEXPANDED one returns the NEKT_SUPPORT_ID sentinel string — same scalar-id vs object shape as a normal user. We never return the real user's id here (the frontend would resolve it against the org and surface the impersonated customer instead of "Nekt Support").

id
string<uuid>
required
read-only
token
string
required
read-only
expires_at
string<date-time>
required
read-only
created_at
string<date-time>
required
read-only
created_by
integer
required
read-only

User that created this setup token (Expandable)

connector_config_fields
any | null

Restricts which connector config fields are visible/editable through this setup token. Null (the default) makes every field available, matching prior behavior. false hides a field (and its children); a list or object narrows availability to the named fields, recursing into their children with the same semantics.