Creative briefs API


POST /api/v1/products/:product_id/creative_briefs

Create a creative brief

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

POST /api/v1/products/MW1/creative_briefs

Example CURL command

curl "https://account1.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": "6654698176599185544",
    "name": "April launch",
    "color": 13421772,
    "created_at": "2019-02-06T01:47:39.775Z",
    "updated_at": "2019-02-06T01:47:39.787Z",
    "url": "http://account1.example.org/creative_briefs/6654698176599185544",
    "resource": "http://account1.example.org/creative_briefs/6654698176599185544",
    "custom_fields": [

    ],
    "comments_count": 0
  }
}

GET /api/v1/products/:product_id/creative_briefs

Get all of the creative briefs in a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve creative briefs for

GET /api/v1/products/MW1/creative_briefs

Example CURL command

curl -g "https://account1.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-02-06T01:47:32.000Z"
    },
    {
      "id": "982259096",
      "name": "June launch",
      "created_at": "2019-02-06T01:47:32.000Z"
    },
    {
      "id": "91171755",
      "name": "May launch",
      "created_at": "2019-02-06T01:47:32.000Z"
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/creative_briefs/:id

Get a specific creative_brief

Parameters

Name Description
id * Numeric ID of the creative brief to be retrieved

GET /api/v1/creative_briefs/476477971

Example CURL command

curl -g "https://account1.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-02-06T01:47:32.000Z",
    "updated_at": "2019-02-06T01:47:32.000Z",
    "url": "http://account1.example.org/creative_briefs/476477971",
    "resource": "http://account1.example.org/creative_briefs/476477971",
    "custom_fields": [

    ],
    "comments_count": 0
  }
}

GET /api/v1/creative_briefs

Search creative briefs by name

Parameters

Name Description
q Sub-string to match against creative brief name

GET /api/v1/creative_briefs?q=April+launch

Example CURL command

curl -g "https://account1.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-02-06T01:47:32.000Z"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

PUT /api/v1/products/:product_id/creative_briefs/:id

Update a creative brief

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

PUT /api/v1/products/MW1/creative_briefs/476477971

Example CURL command

curl "https://account1.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-02-06T01:47:32.000Z",
    "updated_at": "2019-02-06T01:47:40.087Z",
    "url": "http://account1.example.org/creative_briefs/476477971",
    "resource": "http://account1.example.org/creative_briefs/476477971",
    "custom_fields": [

    ],
    "comments_count": 0
  }
}

DELETE /api/v1/products/:product_id/creative_briefs/:id

Delete a creative brief

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

DELETE /api/v1/products/MW1/creative_briefs/476477971

Example CURL command

curl "https://account1.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
  

Overview

API Resources