Add subscribers to post

Add one or more subscribers to a post

POST/subscribers

Authorization

AuthorizationBearer token · headerrequired

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

Request body

requiredapplication/json

postIdstring<uuid>required

userIdsstring<uuid>[]required

Responses

200

Subscribers added

createdSubscribersSubscriber[]

Show properties

Array of Subscriber

idstring<uuid>

userSubscriberUser

Show properties

idstring<uuid>

firstNamestring | null

lastNamestring | null

createdBySubscriberUser

Show properties

idstring<uuid>

firstNamestring | null

lastNamestring | null

createdAtstring<date-time>

existingSubscribersSubscriber[]

Show properties

Array of Subscriber

idstring<uuid>

userSubscriberUser

Show properties

idstring<uuid>

firstNamestring | null

lastNamestring | null

createdBySubscriberUser

Show properties

idstring<uuid>

firstNamestring | null

lastNamestring | null

createdAtstring<date-time>

400

Bad Request - Invalid input parameters

codestring

messagestring

dataobject

Show properties

errorsobject

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

Bodyapplication/json

Request body

Request

curl -X POST 'https://app.tryordinal.com/api/v1/subscribers' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "userIds": [
    "550e8400-e29b-41d4-a716-446655440011",
    "550e8400-e29b-41d4-a716-446655440012"
  ]
}'

const response = await fetch("https://app.tryordinal.com/api/v1/subscribers", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"postId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"userIds\": [\n    \"550e8400-e29b-41d4-a716-446655440011\",\n    \"550e8400-e29b-41d4-a716-446655440012\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://app.tryordinal.com/api/v1/subscribers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"postId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"userIds\": [\n    \"550e8400-e29b-41d4-a716-446655440011\",\n    \"550e8400-e29b-41d4-a716-446655440012\"\n  ]\n}",
)

Response

{
  "createdSubscribers": [
    {
      "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"
    }
  ],
  "existingSubscribers": [
    {
      "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": "BAD_REQUEST",
  "message": "Bad Request",
  "data": {
    "errors": {
      "publishAt": [
        "Invalid date format"
      ],
      "status": [
        "Invalid enum value"
      ]
    }
  }
}

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

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