Flavours API
Advertisement

Update Advertisement

POST
/api/v2/advertisements/{advertisementId}

Update a specific advertisement by its ID.

AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Path Parameters

advertisementId*string

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Request Body

application/json

type?|

Advertisement type.

Value in"BANNER" | "SMS" | "WHATSAPP"
status?|

Advertisement status.

Value in"PROCESS" | "ACCEPTED" | "REJECTED" | "SUCCESS"
content?|

Advertisement content.

notes?|

Internal notes.

receiver_ids*array<>

The id of an existing record in the users table.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:8000/api/v2/advertisements/laborum" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "receiver_ids": [      "nulla"    ]  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Update Success"
  },
  "data": {
    "id": "6181eae3-424a-46f8-9948-79c7500826c7",
    "market_id": "07928d80-350c-46eb-8786-91a40ca509a0",
    "type": "BANNER",
    "status": "PROCESS",
    "content": "https://via.placeholder.com/640x480.png/00ff00?text=et",
    "notes": "Veritatis sit eius id repudiandae voluptatem pariatur molestiae.",
    "approved_by": "cdaafd5e-ba6e-4435-8c50-6725d194e18d",
    "start_at": 1782824826048,
    "close_at": 1782911226048,
    "created_at": 1782824824133,
    "updated_at": 1782824828778
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 422,
    "status": "error",
    "message": "The selected type is invalid. (and 1 more error)"
  },
  "data": [
    {
      "code": 0,
      "message": "The selected type is invalid.",
      "field": "type"
    },
    {
      "code": 0,
      "message": "The selected status is invalid.",
      "field": "status"
    }
  ]
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}