Skip to contentDevelopersPrezly website
Newsrooms

Create a Newsroom

Create a newsroom with an explicit locale, subdomain, and initial availability.

Personal token scopes: sites:write. Your account must also have access to the requested data. Authentication

Current creation also accepts status, active_theme, and with_demo_content. An inactive status keeps setup offline; verify the returned newsroom before publishing.

Read the guide

POST
/newsrooms

Create a Newsroom.

Personal access tokens: sites:write. Every listed scope is required; the token owner's permissions, feature availability and newsroom access still apply.

Authorization

API_key
headerAuthorizationBearer <token>

Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.

Request Body

application/json
  1. body
name*string
Length1 <= length
subdomain*string

Desired newsroom subdomain. Will be used to access the newsroom: {subdomain}.prezly.com.

Match[a-z0-9-]+
Length1 <= length <= 63
cultures?array<>

List of locales the newsroom should have.

Items1 <= items
default_culture?LocaleCode

Language code (ISO 639-1 or ISO 639-2), with optional script designator (ISO 15924) and optional region code (ISO 3166-1).

Match[a-z]{2,3}(_[A-Z][a-z]{3})?(_[A-Z]{2})?
Length2 <= length
newsroom_logo?

Object containing info about an uploaded image.

See Images and Files on how to handle images.

square_logo?

Object containing info about an uploaded image.

See Images and Files on how to handle images.

active_theme?string

Theme ID or codename.

status?string

Hosted-site status; use inactive to prepare a site before making it public.

Value in"inactive""active"
with_demo_content?boolean

Create demo content when true.

Response Body

Created

application/json
  1. response
newsroom*

Full newsroom object containing all properties.

Example Request
curl -X POST 'https://api.prezly.com/v2/newsrooms' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "subdomain": "string"}'
Example Response201
{  "newsroom": {    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",    "id": 0,    "name": "string",    "display_name": "string",    "domain": "string",    "subdomain": "string",    "thumbnail_url": "http://example.com",    "timezone": "europe/london",    "is_hub": true,    "is_active": true,    "is_archived": true,    "is_online": true,    "is_offline": true,    "is_multilingual": true,    "is_indexable": true,    "campaigns_number": 0,    "stories_number": 0,    "url": "http://example.com",    "cultures": [      {        "code": "en",        "name": "string",        "direction": "ltr",        "language_code": "en",        "native_name": "string"      }    ],    "square_logo": {      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",      "version": 0,      "filename": "string",      "mime_type": "string",      "size": 0,      "original_width": 0,      "original_height": 0,      "effects": [        "string"      ]    },    "newsroom_logo": {      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",      "version": 0,      "filename": "string",      "mime_type": "string",      "size": 0,      "original_width": 0,      "original_height": 0,      "effects": [        "string"      ]    },    "icon": {      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",      "version": 0,      "filename": "string",      "mime_type": "string",      "size": 0,      "original_width": 0,      "original_height": 0,      "effects": [        "string"      ]    },    "links": {      "media_gallery_api": "http://example.com",      "room_contacts_api": "http://example.com",      "analytics_and_visibility_settings": "http://example.com",      "categories_management": "http://example.com",      "company_info_settings": "http://example.com",      "contacts_management": "http://example.com",      "domain_settings": "http://example.com",      "edit": "http://example.com",      "gallery_management": "http://example.com",      "hub_settings": "http://example.com",      "languages": "http://example.com",      "look_and_feel_settings": "http://example.com",      "privacy_settings": "http://example.com",      "widget_settings": "http://example.com"    },    "date_format": "string",    "time_format": "string",    "email_branding_mode": "default",    "email_branding": {      "background_color": "string",      "title_color": "string",      "text_color": "string",      "link_color": "string"    },    "custom_privacy_policy_link": "string",    "tracking_policy": "default",    "cookiepro": {      "is_enabled": true,      "category": "string"    },    "is_subscription_form_enabled": true,    "ga_tracking_id": "string",    "custom_data_request_link": "string",    "is_white_labeled": true  }}