---
title: "program.unassigned"
description: "Delivered when program.unassigned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock."
image: "https://docs.quirelms.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Quire API

`POST program.unassigned`

_Webhook._

Delivered when program.unassigned occurs. Signed per the Standard Webhooks specification: verify the webhook-signature header over the exact bytes of webhook-id, webhook-timestamp and the raw body, and reject a timestamp more than five minutes from your own clock.

## Request body

_Required._

- `program.unassigned.id` (string, required) — Equal to the webhook-id header and to the outbox event identifier. Deduplicate on it.
- `program.unassigned.type` (string, required)
- `program.unassigned.version` (integer, required)
- `program.unassigned.occurred_at` (string, required)
  - format `date-time`
- `program.unassigned.tenant` (object, required)
  - `program.unassigned.tenant.id` (string, required)
  - `program.unassigned.tenant.slug` (string, required)
- `program.unassigned.subscription_id` (string, required)
- `program.unassigned.livemode` (boolean, required)
- `program.unassigned.data` (object, required)
  - `program.unassigned.data.assignment_id` (string, required)
    - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
  - `program.unassigned.data.enrolment_action` (string, required)
    - one of `"suspend"`, `"unenrol"`, `"none"`
  - `program.unassigned.data.program_id` (string, required)
    - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
  - `program.unassigned.data.reason` (string, required)
  - `program.unassigned.data.user_id` (string, required)
    - format `uuid`; pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`
- `program.unassigned.links` (map<string>, optional) — Where to read the current state of what the event is about.

## Example request

```json
{
  "id": "string",
  "type": "program.unassigned",
  "version": 1,
  "occurred_at": "2019-08-24T14:15:22Z",
  "tenant": {
    "id": "string",
    "slug": "string"
  },
  "subscription_id": "string",
  "livemode": true,
  "data": {
    "assignment_id": "d43495bb-b4cb-46c1-906a-f8265fda9c73",
    "enrolment_action": "suspend",
    "program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
    "reason": "string",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
  },
  "links": {
    "property1": "http://example.com",
    "property2": "http://example.com"
  }
}
```

## Responses

### 2XX

Any 2xx acknowledges the delivery. A 410 disables the subscription. Anything else is retried with exponential backoff and full jitter over about 36 hours.


Source: https://docs.quirelms.com/api/webhooks/program.unassigned/index.md