Projects

Update an existing project

Updates project details including name, description, and associated Apple app integrations.

put/projects/{id}

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/projects/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Organization project ID with orgproj_ prefix

Request body

namestring

Project name

descriptionstring

Project description

logostring

Project logo

appleAppIdstring nullable

Apple app ID

visibleToCreatorsboolean

Whether creators see this tag's name where it decides their pay (campaign payout conditions). When false, creators see “videos the brand selects” instead. Country and continent tags are always visible.

Example request

{
  "name": "Holiday Campaign 2025",
  "url": "https://www.example.com/holiday-campaign-2025",
  "description": "Updated winter holiday marketing campaign for 2025",
  "logo": "https://www.example.com/images/holiday-logo-2025.png",
  "appleAppId": "orgaplapp_M5YTB9R4W8KP"
}

Response

OK

idstring required
namestring required
urlstring nullable required
descriptionstring nullable required
logostring nullable required
appleAppIdstring nullable required
visibleToCreatorsboolean required
createdAtstring date-time required
updatedAtstring date-time required
actorType'user' | 'system' | 'api_token' required
userIdstring required
orgIdstring required

Example response

{
  "id": "orgproj_RwmraAffhMt9",
  "name": "Holiday Campaign 2025",
  "url": "https://www.example.com/holiday-campaign-2025",
  "description": "Updated winter holiday marketing campaign for 2025",
  "logo": "https://www.example.com/images/holiday-logo-2025.png",
  "appleAppId": "orgaplapp_2B3C4D5E6F7G",
  "visibleToCreators": true,
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-12-20T15:30:00.000Z",
  "userId": "user_PxyfnFj5JUx5",
  "orgId": "org_GbuDqv3RjdSW"
}

Changes

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