Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

A contact session token, uk_ct_…. Belongs to one of the developer's own users, and reads only that user's data.

Headers

X-Customer-Id
string<uuid>

The customer this call is acting inside — the same arrangement as X-Organization-Id, one plane down. Switching customers is navigation, not a mutation: nothing is stored, you send a different header, and the membership JOIN behind it decides what you may do there. An id you are not a member of matches no row and answers 404. Absent, the contact's oldest membership answers.

Path Parameters

id
string<uuid>
required

The endpoint's id.

Body

application/json
url
string<uri>
description
string
subscribed_events
string[]
Required array length: 1 - 20 elements
status
enum<string>
Available options:
enabled,
disabled

Response

The endpoint as it now stands.

id
string<uuid>
url
string<uri>

Where deliveries are POSTed. https:// only.

plane
enum<string>

Always customer on this surface. The plane is set when the endpoint is registered and never afterwards.

Available options:
customer
description
string
subscribed_events
string[]

The event names this team hears — the product's own vocabulary (pedido.aprovado), not UserKit's catalogue. Never empty: the product's vocabulary is open-ended, so "everything" is not a subscription anybody can mean.

Required array length: 1 - 20 elements
status
enum<string>

disabled is either the team's decision or the auto-disable after sustained failure. A disabled endpoint is queued nothing.

Available options:
enabled,
disabled
consecutive_failures
integer

Deliveries that spent every attempt, back to back. Any success resets it.

disabled_at
string<date-time> | null
disabled_reason
string
recent_failures
integer

Deliveries that gave up in the last 24 hours.

created_at
string<date-time>