curl --request PATCH \
  --url https://app.tryordinal.com/api/v1/engagements/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "copy": "Updated comment text with great insights!",
  "delaySeconds": 600
}
'

{
  "engagement": {
    "id": "550e8400-e29b-41d4-a716-446655440801",
    "type": "Comment",
    "profileId": "550e8400-e29b-41d4-a716-446655440002",
    "copy": "Updated comment text with great insights!",
    "delaySeconds": 600
  }
}

{
  "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"
}

Engagements

Update an engagement

Update an existing engagement’s copy, delay, profile, or reaction type.

Validation rules:

copy cannot be updated for Like engagements
copy cannot be removed from Comment engagements (must have content)
delaySeconds cannot be updated for Like engagements
reactionType can only be updated for Like engagements on LinkedIn
When changing profileId, the new profile must have the required engagement permissions
Cannot update engagements for posts that have already been published
Only one Like engagement per profile is allowed (cannot change profileId to a profile that already has a Like)

PATCH

engagements

{id}

curl --request PATCH \
  --url https://app.tryordinal.com/api/v1/engagements/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "copy": "Updated comment text with great insights!",
  "delaySeconds": 600
}
'

{
  "engagement": {
    "id": "550e8400-e29b-41d4-a716-446655440801",
    "type": "Comment",
    "profileId": "550e8400-e29b-41d4-a716-446655440002",
    "copy": "Updated comment text with great insights!",
    "delaySeconds": 600
  }
}

{
  "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"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Engagement ID (UUID)

Body

application/json

All fields are optional. Only include the fields you want to update.

copy

string | null

The text content. Cannot be updated for Like engagements. Cannot be removed from Comment engagements. Set to null to remove copy from Repost engagements.

Minimum string length: 1

delaySeconds

integer | null

Delay in seconds after the post publishes. Accepts any integer from 0 to 86400 (24 hours). Cannot be updated for Like engagements.

Required range: 0 <= x <= 86400

profileId

string<uuid>

Change the profile that will perform the engagement. The new profile must have the required engagement permissions.

reactionType

enum<string>

Update the LinkedIn reaction type for Like engagements. Only applicable when type is Like and channel is LinkedIn.

Available options:

Like,

Celebrate,

Love,

Insightful,

Support,

Funny

Response

Engagement updated

engagement

object

Engagement object returned from update operations (without channel)

Show child attributes

Delete an engagement List pending invites

⌘I

Overview

Endpoints

Update an engagement

Authorizations

Path Parameters

Body

Response