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}

Request

Base URL
https://app.tryordinal.com/api/v1/company
Auth
HTTP bearer
TypeScript
https://skmtc.dev/tryordinal/apis/ordinal-agency-api/docs/engagements/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Engagement ID (UUID)

Request body

copystring nullable

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

delaySecondsinteger nullable

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

profileIdstring uuid

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

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

Response

Engagement updated

Changes

No recorded changes to this operation across all 1 revision of this API.