Brand key required

Brand profile

The identity behind your key. GET /v1/brand doubles as the cheapest smoke test for a new integration: if it returns your company name, auth is wired correctly.

Get your profile

GET/v1/brand

request

curl "https://api.ugcroster.com/v1/brand" \
  -H "Authorization: Bearer rsk_brand_key"

response 200

{
  "data": {
    "id": "brand_abc123",
    "name": "Glow Skincare",
    "logo": "https://cdn.ugcroster.com/logos/glow.png",
    "contact_name": "Sarah Johnson",
    "contact_email": "sarah@glowskincare.com",
    "email": "owner@glowskincare.com",
    "phone": "+1 555 010 0199",
    "website": "https://glowskincare.com",
    "industry": "Beauty & Skincare",
    "description": "Clean skincare for everyday glow.",
    "plan": "growth",
    "subscription_status": "active",
    "created_at": "2025-01-15T10:30:00Z"
  }
}

plan and subscription_status are read-only: they reflect your Roster subscription and cannot be set via the API.

Update your profile

PATCH/v1/brand

Partial update: send only the fields you want to change. All fields accept snake_case or camelCase names. Sending an empty string clears a field to null.

Field	Type	Description
company_name	string	Brand display name.
contact_name	string	Primary contact person.
contact_email	string	Contact email. Also used as the reply-to on creator emails sent via the API.
phone	string	Contact phone number.
website	string	Brand website URL.
industry	string	Industry label, free text.
description	string	Short brand description shown to creators.
logo_url	string	Logo image URL. Must start with https:// (or be empty to clear); anything else is rejected with 422 VALIDATION_ERROR.

request

curl -X PATCH "https://api.ugcroster.com/v1/brand" \
  -H "Authorization: Bearer rsk_brand_key" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Glow Skincare Co.",
    "description": "Premium clean skincare.",
    "logo_url": "https://cdn.glowskincare.com/logo.png"
  }'

response 200

{
  "data": {
    "id": "brand_abc123",
    "name": "Glow Skincare Co.",
    "logo": "https://cdn.glowskincare.com/logo.png",
    "contact_name": "Sarah Johnson",
    "contact_email": "sarah@glowskincare.com",
    "description": "Premium clean skincare.",
    "plan": "growth",
    "subscription_status": "active"
  }
}

The response is the re-fetched full profile, not just the fields you sent. A body with no recognized fields returns 422 VALIDATION_ERROR(“No valid fields to update”).

Campaigns →

Create and manage campaigns under this brand.

Authentication →

Data keys vs brand keys, rotation, scope.