Advertisement
Create Advertisement
Create a new advertisement with the provided data.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
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
market_id*string
Market ID. The id of an existing record in the markets table.
type*string
Advertisement type.
Value in
"BANNER" | "SMS" | "WHATSAPP"content*string
Advertisement content (URL for BANNER, text for SMS/WHATSAPP).
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" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "market_id": "uuid", "type": "BANNER", "content": "https://example.com/banner.jpg", "receiver_ids": [ "aut" ] }'{
"meta": {
"code": 200,
"status": "success",
"message": "Create Success"
},
"data": {
"id": "c36bbaa0-57be-47f9-b1bf-80baa484a430",
"market_id": "07928d80-350c-46eb-8786-91a40ca509a0",
"type": "BANNER",
"status": "PROCESS",
"content": "https://via.placeholder.com/640x480.png/00bb33?text=sit",
"notes": null,
"approved_by": null,
"start_at": 1782824826213,
"close_at": 1782911226213,
"created_at": 1782824826191,
"updated_at": 1782824826191
}
}{
"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 market id is invalid. (and 1 more error)"
},
"data": [
{
"code": 0,
"message": "The selected market is invalid.",
"field": "market"
},
{
"code": 0,
"message": "The selected type is invalid.",
"field": "type"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}