Project

Set Project Profile

Changed on

Replace the project's brand profile. All fields are required — the entire profile is overwritten. Triggers a background refresh of prompt suggestions. Audience distribution percentages must sum to 100. The project's display name is not part of the profile and cannot be changed via this endpoint. Returns 403 while the project is in onboarding.

put/project-profile

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/project-profile
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Request body

occupationstring required

The role or perspective the profile speaks from, e.g. 'Founder'.

industrystring required

The industry the brand operates in, e.g. 'SaaS'.

brand_presentationstring[]

Short statements describing how the brand presents itself, e.g. ["Premium eco-friendly cleaning products"].

brandPresentationstring[]

Deprecated camelCase alias of brand_presentation, e.g. ["Premium eco-friendly cleaning products"].

products_and_servicesstring[]

The products and services the brand offers, e.g. ["CRM software","Analytics dashboard"].

productsAndServicesstring[]

Deprecated camelCase alias of products_and_services, e.g. ["CRM software","Analytics dashboard"].

personasstring[]

The audience segments prompts are written from the perspective of, e.g. ["Marketing lead","Procurement manager"]. Omit to leave the project's existing personas untouched.

Response

Project profile set successfully

object required

Project profile set successfully

Changes

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)