Skip to main content
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
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
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
enum<integer> | null

Delay in seconds after post publishes. Cannot be updated for Like engagements.

Available options:
0,
300,
600,
1800,
3600,
14400,
28800,
43200,
86400
​
profileId
string<uuid>

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

Response

Engagement updated

​
engagement
object

Engagement object returned from update operations (without channel)