recommendations

Update Recommendation

Update recommendation status and implementation notes.

patch/api/v1/recommendations/{recommendation_id}

Request

  • Base URL: https://geo.sig.ai (the document declares no server; this is the origin it was published from)
  • URL: https://geo.sig.ai/api/v1/recommendations/{recommendation_id}
  • Auth: HTTP bearer

Path parameters

recommendation_idstring uuid required

Cookies

access_tokenstring nullable

Request body

statusstring required

New status: pending, in_progress, completed, dismissed

implementation_notesstring nullable

Notes about implementation

dismissed_reasonstring nullable

Reason for dismissal (required if status=dismissed)

Response

Successful Response

idstring uuid required
brand_idstring uuid required
created_atstring date-time required
updated_atstring date-time required
typestring required
prioritystring required
categorystring required
titlestring required
descriptionstring required
rationalestring required
target_urlstring nullable required
target_sectionstring nullable required
suggested_contentstring required
estimated_impact_scorestring nullable required
estimated_visibility_increaseinteger nullable required
competitor_advantagestring nullable required
statusstring required
implemented_atstring date-time nullable required
dismissed_reasonstring nullable required

Changes

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