Delete subscriber

Remove a subscriber from a post

DELETE/subscribers/{id}

Authorization

AuthorizationBearer token · headerrequired

API key authentication. Generate an API key from your workspace settings.

Path parameters

idstring<uuid>required

Subscriber ID (UUID)

Responses

200

Subscriber removed

deletedSubscriberSubscriber

Show properties

idstring<uuid>

userSubscriberUser

Show properties

idstring<uuid>

firstNamestring | null

lastNamestring | null

createdBySubscriberUser

Show properties

idstring<uuid>

firstNamestring | null

lastNamestring | null

createdAtstring<date-time>

401

Unauthorized - Missing or invalid API key

codestring

messagestring

404

Not Found - Resource does not exist

codestring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idpath*Subscriber ID (UUID)

Request

curl -X DELETE 'https://app.tryordinal.com/api/v1/subscribers/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://app.tryordinal.com/api/v1/subscribers/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.delete(
    "https://app.tryordinal.com/api/v1/subscribers/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "deletedSubscriber": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "firstName": "string",
      "lastName": "string"
    },
    "createdBy": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "firstName": "string",
      "lastName": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid or unauthorized API key"
}

{
  "code": "NOT_FOUND",
  "message": "Post not found or does not belong to this workspace"
}