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}

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstring<uuid>required

Engagement ID (UUID)

Request body

requiredapplication/json

copystring | 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.

min length 1

delaySecondsinteger | null

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

min 0 · max 86400

profileIdstring<uuid>

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

reactionTypeLinkedInReactionType

LinkedIn reaction type for Like engagements. Only applicable when type is Like and channel is LinkedIn. Defaults to Like if not specified.

Allowed:LikeCelebrateLoveInsightfulSupportFunny

Responses

200

Engagement updated

engagementEngagementResponse

Engagement object returned from update operations (without channel)

Show properties

idstring<uuid>

typeEngagementType

Allowed:LikeCommentRepost

profileIdstring<uuid>

The profile ID that will perform the engagement

copystring | null

The text content for Comment or Repost engagements

delaySecondsinteger

Delay in seconds after post publishes

reactionTypeLinkedInReactionType

LinkedIn reaction type for Like engagements. Only applicable when type is Like and channel is LinkedIn. Defaults to Like if not specified.

Allowed:LikeCelebrateLoveInsightfulSupportFunny

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

Parameters

idpath*Engagement ID (UUID)

Bodyapplication/json

copystringThe text content. Cannot be updated for Like engagements. Cannot be removed from Comment engagements. Set to null to remove copy from Repost engagements.delaySecondsintegerDelay in seconds after the post publishes. Accepts any integer from 0 to 86400 (24 hours). Cannot be updated for Like engagements.profileIdstringChange the profile that will perform the engagement. The new profile must have the required engagement permissions.reactionTypestringLinkedIn reaction type for Like engagements. Only applicable when type is Like and channel is LinkedIn. Defaults to Like if not specified.

Request

curl -X PATCH 'https://app.tryordinal.com/api/v1/engagements/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "copy": "Updated comment text with great insights!",
  "delaySeconds": 600
}'

const response = await fetch("https://app.tryordinal.com/api/v1/engagements/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"copy\": \"Updated comment text with great insights!\",\n  \"delaySeconds\": 600\n}"
});

import requests

response = requests.patch(
    "https://app.tryordinal.com/api/v1/engagements/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"copy\": \"Updated comment text with great insights!\",\n  \"delaySeconds\": 600\n}",
)

Response

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