Skip to main content
DELETE
/
api
/
partner
/
v2
/
receivers
/
{id}
cURL
curl --request DELETE \
  --url https://staging-api.capa.fi/api/partner/v2/receivers/{id} \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <partner-api-key>' \
  --data '
{
  "userId": "550e8400-e29b-41d4-a716-446655440000"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "disabled": true
  }
}
Disables (soft-deletes) a receiver by id for the specified userId.

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Path Parameters

​
id
string
required

Receiver identifier

Example:

"9486244c-ff7d-4c22-9984-797179d7deaa"

Body

application/json
​
userId
string
required

User ID who owns this receiver (for authorization)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

200 - application/json
​
success
boolean
Example:

true

​
data
object