Creative briefs API
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to create the creative brief in |
| name * | Name of the creative brief |
| color | Hex color of the creative brief in the Aha! UI |
Example Request
POST /api/v1/products/MW1/creative_briefs
Example CURL command
curl "https://company.aha.io/api/v1/products/MW1/creative_briefs" -d $'{"creative_brief":{"name":"April launch"}}' -X POST \
-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
{
"creative_brief": {
"name": "April launch"
}
}
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"creative_brief": {
"id": "6825596030276674846",
"name": "April launch",
"color": 13421772,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/creative_briefs/6825596030276674846",
"resource": "http://company.aha.io/creative_briefs/6825596030276674846",
"custom_fields": [
],
"comments_count": 0
}
}
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to retrieve creative briefs for |
Example Request
GET /api/v1/products/MW1/creative_briefs
Example CURL command
curl -g "https://company.aha.io/api/v1/products/MW1/creative_briefs" -X GET \ -H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"creative_briefs": [
{
"id": "476477971",
"name": "April launch",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "982259096",
"name": "June launch",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "91171755",
"name": "May launch",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"pagination": {
"total_records": 3,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| id * | Numeric ID of the creative brief to be retrieved |
Example Request
GET /api/v1/creative_briefs/476477971
Example CURL command
curl -g "https://company.aha.io/api/v1/creative_briefs/476477971" -X GET \ -H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"creative_brief": {
"id": "476477971",
"name": "April launch",
"color": 13421772,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/creative_briefs/476477971",
"resource": "http://company.aha.io/creative_briefs/476477971",
"custom_fields": [
],
"comments_count": 0
}
}
Parameters
| Name | Description |
|---|---|
| q | Sub-string to match against creative brief name |
Example Request
GET /api/v1/creative_briefs?q=April+launch
Example CURL command
curl -g "https://company.aha.io/api/v1/creative_briefs?q=April+launch" -X GET \ -H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"creative_briefs": [
{
"id": "476477971",
"name": "April launch",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"pagination": {
"total_records": 1,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to create the creative brief in |
| id * | Numeric ID, or key of the creative brief to be updated |
| name | Name of the creative brief |
| color | Hex color of the creative brief in the Aha! UI |
Example Request
PUT /api/v1/products/MW1/creative_briefs/476477971
Example CURL command
curl "https://company.aha.io/api/v1/products/MW1/creative_briefs/476477971" -d $'{"creative_brief":{"name":"December launch"}}' -X PUT \
-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
{
"creative_brief": {
"name": "December launch"
}
}
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"creative_brief": {
"id": "476477971",
"name": "December launch",
"color": 13421772,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/creative_briefs/476477971",
"resource": "http://company.aha.io/creative_briefs/476477971",
"custom_fields": [
],
"comments_count": 0
}
}
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to create the creative brief in |
| id * | Numeric ID, or key of the creative brief to be deleted |
Example Request
DELETE /api/v1/products/MW1/creative_briefs/476477971
Example CURL command
curl "https://company.aha.io/api/v1/products/MW1/creative_briefs/476477971" -d $'' -X DELETE \ -H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
Response
Status: 204 No Content