Brands

The account’s brands and its communities’, the default brand and the settings#

GET /v1/account/brands

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/brands" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Make a brand for the account, or for one community#

POST /v1/account/brands

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/brands" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "look": {
    "primary": "string",
    "accent": "string"
  }
}'

Dismiss the notice about the email brand moving into Brands (ADR 0130)#

DELETE /v1/account/brands/email-merge-notes

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/brands/email-merge-notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Upload a brand’s logo or cover photo (multipart: file, plus a kind of logo or photo). Returns its public URL#

POST /v1/account/brands/media

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 201

Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/brands/media" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Set the account’s default brand and whether communities may make their own#

PUT /v1/account/brands/settings

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/brands/settings" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "communitiesMayCreate": true,
  "defaultBrandId": "brd_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
}'

Rename a brand or change its look#

PATCH /v1/account/brands/{brandId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PATCH "$ANSWERSTACK_API_URL/v1/account/brands/{brandId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "look": {
    "primary": "string",
    "accent": "string"
  },
  "name": "string"
}'

Delete a brand nothing uses#

DELETE /v1/account/brands/{brandId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/brands/{brandId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Choose a community’s brand: an account brand or one of its own. Null: the default#

PUT /v1/account/groups/{groupId}/brand

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/groups/{groupId}/brand" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "brandId": "brd_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
}'