openapi: 3.2.0 info: version: 2.0.0 title: Opal Accounts API license: name: Opal API License url: https://www.workwithopal.com/api-license description: "The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [[RFC2119](https://tools.ietf.org/html/rfc2119)] [[RFC8174](https://tools.ietf.org/html/rfc8174)] when, and only when, they appear in all capitals, as shown here.\n\n# Other API Versions\n\nThe [v3 API](/api/documentation/v3) is less complete than the v2 API, and is still a work in progress. Currently, if a resource has endpoints in both the v2 API and the v3 API you **SHOULD** use the v2 API endpoints. At some point in the future we will recommend the v3 API instead.\n\n# Documentation Organization\n\nv2 API endpoints are categorized by stability:\n\n1. JSON:API\n2. Other\n3. Unstable\n4. Proposed\n\nv2 API endpoints in the “JSON:API”, “Unstable”, and “Proposed” categories are [JSON:API](https://jsonapi.org)-compliant ([specification](https://jsonapi.org/format/)) and can be used with any [JSON:API-compliant client](https://jsonapi.org/implementations/).\n\n\n\n“Other” endpoints are stable, but do not follow the JSON:API specification. (Some “Other” endpoints have data that resembles the JSON:API structure, but **MUST** be parsed as generic JSON.) Your requests **MUST** set the `Accept` HTTP header to `application/json`, and the response’s `Content-Type` HTTP header will be `application/json`.\n\n## Unstable Endpoints\n\n*Note:* This generally refers resources in the “Unstable” category, but includes endpoints with a summary that’s prefixed by `[UNSTABLE]`. These `[UNSTABLE]` endpoints may be part of a “Stable” resource.\n\nThe data structure and behavior of “Unstable” endpoints are not guaranteed, and we **MAY** change them at any time. You **MUST NOT** use these endpoints for production features, but **MAY** use them as a preview of upcoming features, and we welcome feedback.\n\n## Proposed Endpoints\n\n“Proposed” endpoints **MUST NOT** be used (they’re not yet implemented), and we **MAY** change or remove them at any time. We publish them at our discretion to share our plans and encourage internal feedback. We also welcome your feedback.\n\n# Design Principles\n\n## Breaking Changes\n\nWe **MAY** expand the data for “JSON:API” and “Other” resources, but will not change or remove existing attributes or relationships for these resources. These expansions should not require any changes to your code.\n\nWe provide no guarantees for “Unstable” and “Proposed” endpoints.\n\n## Firehose Rule\n\nBy default endpoints include all the relevant data that’s accessible to the authenticated user. Clients **MAY** specify filters, ordering, pagination, sparse fields, and other limiting mechanisms to pare down the desired data.\n\n*Note:* Existing endpoints **MAY NOT** follow this maximalist approach, but new endpoints will, and we **MAY** enhance existing endpoints.\n\n## Obscurity\n\nIn order to provide customers with as much privacy as possible, many API calls that fail authorization will return `404 Not Found` rather than `403 Forbidden`. Do not design frontends around the expectation that a `404 Not Found` status code means a resource would not be returned given different authentication credentials.\n\n# Authentication Strategies\n## OAuth 2.0\nOpal uses OAuth 2.0 (https://oauth.net/2) to authenticate users and grant access to protected resources. After registering your application as an OAuth client, you must get permission from each user before accessing their account.\n\nThe main steps are:\n\n1. Register your application\n2. Direct the user to Opal, to authorize your application\n3. Opal confirm's user identity, and asks the user to grant your application permissions\n4. Opal issues tokens your application can use to access the user's Opal resources\n5. Your application can begin making requests to the Opal API on behalf of the user\n\n### Roles\n#### Client\nThe 3rd-party application accessing the API on behalf of the User.\n\n#### API\nAPI endpoints used to interact with a User's resources in Opal.\n\n#### User\nThe person authorizing the Client to access to their Opal account.\n\n### Registering your application\nApplication registration is currently a manual process.\n\nTo begin, you will need to provide the following information to the Opal integrations team:\n\n- Application name\n- Logo URI\n- Redirect URI\n\nIn return, expect to receive:\n\n- Client ID\n - public\n- Application secret\n - keep this private\n - keep this written down someplace safe. Opal cannot retrieve this for you if it is lost.\n\n### Authorization\nFor a Client to make API requests on behalf of Users, the User must first give consent.\nHere is an overview of the consent flow:\n\n1. Direct the User to grant access in Opal\n\n```\nhttps://login.ouropal.com/oauth2/auth?grant_type=authorization_code&scope=offline_access&response_type=code&client_id={client_id}&state={state}&redirect_uri={url_encoded_redirect}\n```\n\nParameters:\n- `client_id`: Provided by Opal.\n- `grant_type`: Set the value to authorization_code to receive a code string that can be exchanged for an access token.\n- `redirect_uri`: Defined by Client. After authentication, the user will be directed to this location.\n- `response_type`: The value code should be set for refresh tokens to be issued.\n- `scope`: The value offline_access must be present if you wish to use refresh tokens.\n- `state`: Defined by the Client. A unique value used to validate the response.\n\n\n2. If logged out, User is directed to log in to Opal\n\n3. User is redirected to consent page (if the User has not already given consent)\n\n```\nhttps://login.ouropal.com/oauth2/consent?consent_challenge=abc123\n```\n\n4. If the User grants permission, User is sent to the specified `redirect_uri`\n\n```\nhttps://example.com/defined-by-client?code=Mu9z2DndN7TfXSLaf99O8ReqqXqMabXhSqP5e0jlx_Q.naLKbko-GyfPJRGYcWyclxU0sBGwygPy05OSFww0XZ8&scope=offline_access&state={state}\n```\n\nParameters:\n- `code`: The Client may use this to get an access token.\n- `scope`: API permissions granted to the Client by the User.\n- `state`: The validation string provided by the Client in step 1.\n\nIf the User declines the consent prompt, User will be sent to the same `redirect_uri`, but with an error parameter :\n\n```\nhttps://example.com/defined-by-client?error=consent+request+denied&state={state}\n```\n\nParameters:\n- `error`: A brief description of the issue.\n- `state`: The validation string provided by the Client in step 1.\n\n### Retrieving Access Token\nYou must make a POST request to the token endpoint to get an access token, before the code expires:\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'code={code}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={client_secret}&grant_type=authorization_code'\n```\n\nParameters:\n- `code`\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to authorization_code .\n- `redirect_uri`: Optional.\n\nIf successful, a JSON-formatted response body will contain the access_token and refresh_token:\n\n```json\n{\n \"access_token\":\"ABC123\",\n \"token_type\":\"bearer\",\n \"expires_in\":3600,\n \"refresh_token\":\"DEF456\",\n \"scope\":\"offline_access\"\n}\n```\n\n### Refreshing an Access Token\nOnce the access_token expires, you may generate a new one at the same token endpoint, but with different parameters.\nNote that in this request, a \"refresh_token\" parameter is used instead of \"code\", and the \"grant_type\" value is now \"refresh_token\" instead of \"authorization_code\".\n\n```\ncurl -X POST \\\n https://login.ouropal.com/oauth2/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d 'refresh_token={refresh_token}&client_id={client_id}&redirect_uri={url_encoded_redirect}&client_secret={secret}&grant_type=refresh_token'\n```\n\nParameters:\n- `client_id`: Client ID provided by Opal.\n- `client_secret`: Client secret provided by Opal.\n- `grant_type`: Set value to refresh_token .\n- `redirect_uri`: Optional.\n- `refresh_token`: Refresh token value\n\n### Making Authenticated Requests\n\nSet an authorization header in your requests, specifying your access token as documented here: https://tools.ietf.org/html/rfc6750#section-2.1.\n\n**NOTE** that the `Authorization` header supercedes the `Session-Token` header described in the documentation for many endpoints. Specifying an `Authorization` header means you do not need to specify a `Session-Token` header.\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\nFor example:\n```\n GET /resource HTTP/1.1\n Host: server.example.com\n Authorization: Bearer mF_9.B5f-4.1JqM\n```\n\n### Client Revoke/Rolling OAuth secrets\nClient secrets must be kept secret and not exposed outside of the token retrieval requests. If a secret has been potentially compromised, please notify Opal as soon as possible and let us know the OAuth client id associated with the secret. We will roll/update the secret, which will invalidate all existing access and refresh tokens. Invalidating tokens will cause users to need to reauthenticate, but consent should be remembered.\n" servers: - url: https://login.ouropal.com tags: - name: Accounts paths: /accounts/{account_id}/placements: get: tags: - Accounts operationId: ReadPlacementsV0 summary: List placements associated with given account security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: account_id in: path required: true description: The ID of the account to fetch placements for schema: type: string - name: include in: query required: false description: A comma separated list of related objects to include schema: type: array items: type: string enum: - account - posts style: form explode: false responses: '200': description: An array of placements content: application/json: schema: type: object required: - data properties: data: type: array items: title: placement type: object required: - relationships - id - attributes - type additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - placement relationships: type: object additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account posts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - content attributes: type: object required: - name additionalProperties: false properties: name: type: string position: type: - number - 'null' included: type: array items: oneOf: - title: content type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - content attributes: type: object required: - position - status - is_published - was_manually_published - is_ghost - is_private - default_snapshot_url - live_url - takedown_scheduled_at - scheduled_at - name - content - show_code_name - publishing_mode - created_at - updated_at additionalProperties: false properties: name: type: string description: The name of the Content. position: type: - integer - 'null' description: 'A relativistic position within the parent Moment. You can sort Content by position to lay them out in the intended order. Note that these positions are not indices (1, 2, 3, 4...). ' status: type: - string - 'null' description: The workflow status of the Content. enum: - draft - for_approval - needs_revision - approved - null content_type: type: - string - 'null' description: The Content Type name of the Content. This attribute is only `null` when the content is private from the currently authenticated user. content: type: - string - 'null' description: 'The unstructured content string of the Content. This is used for Content Types that do not rely on Post Options to store content/assets of Content. ' is_published: type: - boolean - 'null' description: Whether or not the Content has been published. was_manually_published: type: - boolean - 'null' description: Whether or not the Content was manually published. is_ghost: type: boolean description: 'Indicates whether the Content is redacted for the requesting user. ' is_private: type: boolean description: 'Indicates whether the Content is set to private. ' show_code_name: type: boolean description: 'If `is_ghost` is true and `show_code_name` is true then the `name` property is a "code name" for the piece of Content. The user must request access to the Content to see the proper name. ' default_snapshot_url: type: - string - 'null' description: A URL that serves up the default snapshot preview of this Content. live_url: type: - string - 'null' description: The live URL to published Content. scheduled_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time. The date and time when the Content is scheduled to get published. If the Content has not been explicitly scheduled then this date is based on that of the Moment the Content lives within. ' start_interval: type: - string - 'null' description: 'An ISO8601 interval, relative to the start of the related Moment''s schedule, representing the explicitly chosen start datetime of the Content. Values are normalized to a seconds-denominated interval (e.g. `PT86400S`). Null when no specific time has been chosen for the Content — in that case `scheduled_at` falls back to the start of the Moment''s schedule. ' takedown_scheduled_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time. The date and time when the Content is scheduled to get taken down. ' post_data: type: - object - 'null' description: 'A hash that can store any metadata associated with the Content. ' additionalProperties: true publishing_mode: type: - string - 'null' description: The way in which the Content will be published. post_state: type: - string - 'null' description: The state of the Content in the workflow process. enum: - published - held - failed - publishing - dispatched - dispatching - approved - pending created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true service_id: type: integer relationships: type: object required: - account - approval_phase_group - asset_references - brand - budget - delivery_record - inherited_labels - label_sets - labels - links - moment - placement - post_components - post_options - post_type - post_type_options - rich_text_document - service - stories - user additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account approval_phase_group: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - phase-groups asset_references: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand budget: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - budget delivery_record: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - delivery_record inherited_labels: allOf: - type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - description: 'Only inherited labels. See the [Labels Overview](/api/documentation/v2#tag/Labels/Labels-Overview) for information on inheritance. ' label_sets: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label_set labels: allOf: - type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - description: 'All labels (inherited or explicitly set). See the [Labels Overview](/api/documentation/v2#tag/Labels/Labels-Overview) for information on inheritance. ' links: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - link moment: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - moment placement: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement post_components: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_component post_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_option post_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_type post_type_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_option rich_text_document: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service stories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story user: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - user links: type: object additionalProperties: false properties: web_url: type: string - title: account type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - account attributes: type: object required: - name - uuid additionalProperties: false properties: name: type: string uuid: type: string format: uuid relationships: type: object required: - service - brand - dispatch_provider_account - placements additionalProperties: false properties: service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand dispatch_provider_account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - dispatch_provider_account placements: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement '404': description: Account not found. Account ID invalid or user does not have permission to view. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status post: tags: - Accounts operationId: CreatePlacementV0 summary: Create a placement to associate with the given account security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: account_id in: path required: true description: The ID of the account to fetch placements for schema: type: string requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - attributes - type properties: type: type: string enum: - placement attributes: type: object required: - name properties: name: type: string position: type: number responses: '200': description: Placement sucessfully created content: application/json: schema: type: object required: - data properties: data: title: placement type: object required: - relationships - id - attributes - type additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - placement relationships: type: object additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account posts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - content attributes: type: object required: - name additionalProperties: false properties: name: type: string position: type: - number - 'null' included: type: array items: oneOf: - title: content type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - content attributes: type: object required: - position - status - is_published - was_manually_published - is_ghost - is_private - default_snapshot_url - live_url - takedown_scheduled_at - scheduled_at - name - content - show_code_name - publishing_mode - created_at - updated_at additionalProperties: false properties: name: type: string description: The name of the Content. position: type: - integer - 'null' description: 'A relativistic position within the parent Moment. You can sort Content by position to lay them out in the intended order. Note that these positions are not indices (1, 2, 3, 4...). ' status: type: - string - 'null' description: The workflow status of the Content. enum: - draft - for_approval - needs_revision - approved - null content_type: type: - string - 'null' description: The Content Type name of the Content. This attribute is only `null` when the content is private from the currently authenticated user. content: type: - string - 'null' description: 'The unstructured content string of the Content. This is used for Content Types that do not rely on Post Options to store content/assets of Content. ' is_published: type: - boolean - 'null' description: Whether or not the Content has been published. was_manually_published: type: - boolean - 'null' description: Whether or not the Content was manually published. is_ghost: type: boolean description: 'Indicates whether the Content is redacted for the requesting user. ' is_private: type: boolean description: 'Indicates whether the Content is set to private. ' show_code_name: type: boolean description: 'If `is_ghost` is true and `show_code_name` is true then the `name` property is a "code name" for the piece of Content. The user must request access to the Content to see the proper name. ' default_snapshot_url: type: - string - 'null' description: A URL that serves up the default snapshot preview of this Content. live_url: type: - string - 'null' description: The live URL to published Content. scheduled_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time. The date and time when the Content is scheduled to get published. If the Content has not been explicitly scheduled then this date is based on that of the Moment the Content lives within. ' start_interval: type: - string - 'null' description: 'An ISO8601 interval, relative to the start of the related Moment''s schedule, representing the explicitly chosen start datetime of the Content. Values are normalized to a seconds-denominated interval (e.g. `PT86400S`). Null when no specific time has been chosen for the Content — in that case `scheduled_at` falls back to the start of the Moment''s schedule. ' takedown_scheduled_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time. The date and time when the Content is scheduled to get taken down. ' post_data: type: - object - 'null' description: 'A hash that can store any metadata associated with the Content. ' additionalProperties: true publishing_mode: type: - string - 'null' description: The way in which the Content will be published. post_state: type: - string - 'null' description: The state of the Content in the workflow process. enum: - published - held - failed - publishing - dispatched - dispatching - approved - pending created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true service_id: type: integer relationships: type: object required: - account - approval_phase_group - asset_references - brand - budget - delivery_record - inherited_labels - label_sets - labels - links - moment - placement - post_components - post_options - post_type - post_type_options - rich_text_document - service - stories - user additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account approval_phase_group: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - phase-groups asset_references: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand budget: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - budget delivery_record: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - delivery_record inherited_labels: allOf: - type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - description: 'Only inherited labels. See the [Labels Overview](/api/documentation/v2#tag/Labels/Labels-Overview) for information on inheritance. ' label_sets: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label_set labels: allOf: - type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - description: 'All labels (inherited or explicitly set). See the [Labels Overview](/api/documentation/v2#tag/Labels/Labels-Overview) for information on inheritance. ' links: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - link moment: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - moment placement: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement post_components: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_component post_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_option post_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_type post_type_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_option rich_text_document: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service stories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story user: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - user links: type: object additionalProperties: false properties: web_url: type: string - title: account type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - account attributes: type: object required: - name - uuid additionalProperties: false properties: name: type: string uuid: type: string format: uuid relationships: type: object required: - service - brand - dispatch_provider_account - placements additionalProperties: false properties: service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand dispatch_provider_account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - dispatch_provider_account placements: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement '404': description: Account not found. Account ID invalid or user does not have permission to view. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status /accounts/{account_id}/placements/{id}: get: tags: - Accounts operationId: ReadPlacementV0 summary: Get placement by ID security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: account_id in: path required: true description: The ID of the account to fetch placements for schema: type: string - name: id in: path required: true description: The ID of the placement to show/update/destroy schema: type: string - name: include in: query required: false description: A comma separated list of related objects to include schema: type: array items: type: string enum: - account - posts style: form explode: false responses: '200': description: A single placement content: application/json: schema: type: object required: - data properties: data: title: placement type: object required: - relationships - id - attributes - type additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - placement relationships: type: object additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account posts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - content attributes: type: object required: - name additionalProperties: false properties: name: type: string position: type: - number - 'null' included: type: array items: oneOf: - title: content type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - content attributes: type: object required: - position - status - is_published - was_manually_published - is_ghost - is_private - default_snapshot_url - live_url - takedown_scheduled_at - scheduled_at - name - content - show_code_name - publishing_mode - created_at - updated_at additionalProperties: false properties: name: type: string description: The name of the Content. position: type: - integer - 'null' description: 'A relativistic position within the parent Moment. You can sort Content by position to lay them out in the intended order. Note that these positions are not indices (1, 2, 3, 4...). ' status: type: - string - 'null' description: The workflow status of the Content. enum: - draft - for_approval - needs_revision - approved - null content_type: type: - string - 'null' description: The Content Type name of the Content. This attribute is only `null` when the content is private from the currently authenticated user. content: type: - string - 'null' description: 'The unstructured content string of the Content. This is used for Content Types that do not rely on Post Options to store content/assets of Content. ' is_published: type: - boolean - 'null' description: Whether or not the Content has been published. was_manually_published: type: - boolean - 'null' description: Whether or not the Content was manually published. is_ghost: type: boolean description: 'Indicates whether the Content is redacted for the requesting user. ' is_private: type: boolean description: 'Indicates whether the Content is set to private. ' show_code_name: type: boolean description: 'If `is_ghost` is true and `show_code_name` is true then the `name` property is a "code name" for the piece of Content. The user must request access to the Content to see the proper name. ' default_snapshot_url: type: - string - 'null' description: A URL that serves up the default snapshot preview of this Content. live_url: type: - string - 'null' description: The live URL to published Content. scheduled_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time. The date and time when the Content is scheduled to get published. If the Content has not been explicitly scheduled then this date is based on that of the Moment the Content lives within. ' start_interval: type: - string - 'null' description: 'An ISO8601 interval, relative to the start of the related Moment''s schedule, representing the explicitly chosen start datetime of the Content. Values are normalized to a seconds-denominated interval (e.g. `PT86400S`). Null when no specific time has been chosen for the Content — in that case `scheduled_at` falls back to the start of the Moment''s schedule. ' takedown_scheduled_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time. The date and time when the Content is scheduled to get taken down. ' post_data: type: - object - 'null' description: 'A hash that can store any metadata associated with the Content. ' additionalProperties: true publishing_mode: type: - string - 'null' description: The way in which the Content will be published. post_state: type: - string - 'null' description: The state of the Content in the workflow process. enum: - published - held - failed - publishing - dispatched - dispatching - approved - pending created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true service_id: type: integer relationships: type: object required: - account - approval_phase_group - asset_references - brand - budget - delivery_record - inherited_labels - label_sets - labels - links - moment - placement - post_components - post_options - post_type - post_type_options - rich_text_document - service - stories - user additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account approval_phase_group: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - phase-groups asset_references: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand budget: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - budget delivery_record: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - delivery_record inherited_labels: allOf: - type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - description: 'Only inherited labels. See the [Labels Overview](/api/documentation/v2#tag/Labels/Labels-Overview) for information on inheritance. ' label_sets: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label_set labels: allOf: - type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - description: 'All labels (inherited or explicitly set). See the [Labels Overview](/api/documentation/v2#tag/Labels/Labels-Overview) for information on inheritance. ' links: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - link moment: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - moment placement: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement post_components: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_component post_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_option post_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_type post_type_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_option rich_text_document: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service stories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story user: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - user links: type: object additionalProperties: false properties: web_url: type: string - title: account type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - account attributes: type: object required: - name - uuid additionalProperties: false properties: name: type: string uuid: type: string format: uuid relationships: type: object required: - service - brand - dispatch_provider_account - placements additionalProperties: false properties: service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand dispatch_provider_account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - dispatch_provider_account placements: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement '404': description: Placement not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status patch: tags: - Accounts operationId: UpdatePlacementV0 summary: Update placement security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: account_id in: path required: true description: The ID of the account to fetch placements for schema: type: string - name: id in: path required: true description: The ID of the placement to show/update/destroy schema: type: string requestBody: content: application/json: schema: type: object required: - data properties: data: type: object required: - attributes - type - id properties: type: type: string enum: - placement id: type: string attributes: type: object required: - name properties: name: type: string position: type: number responses: '200': description: Placement successfully updated content: application/json: schema: type: object required: - data properties: data: title: placement type: object required: - relationships - id - attributes - type additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - placement relationships: type: object additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account posts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - content attributes: type: object required: - name additionalProperties: false properties: name: type: string position: type: - number - 'null' included: type: array items: oneOf: - title: content type: object required: - id - type - attributes - relationships - links additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - content attributes: type: object required: - position - status - is_published - was_manually_published - is_ghost - is_private - default_snapshot_url - live_url - takedown_scheduled_at - scheduled_at - name - content - show_code_name - publishing_mode - created_at - updated_at additionalProperties: false properties: name: type: string description: The name of the Content. position: type: - integer - 'null' description: 'A relativistic position within the parent Moment. You can sort Content by position to lay them out in the intended order. Note that these positions are not indices (1, 2, 3, 4...). ' status: type: - string - 'null' description: The workflow status of the Content. enum: - draft - for_approval - needs_revision - approved - null content_type: type: - string - 'null' description: The Content Type name of the Content. This attribute is only `null` when the content is private from the currently authenticated user. content: type: - string - 'null' description: 'The unstructured content string of the Content. This is used for Content Types that do not rely on Post Options to store content/assets of Content. ' is_published: type: - boolean - 'null' description: Whether or not the Content has been published. was_manually_published: type: - boolean - 'null' description: Whether or not the Content was manually published. is_ghost: type: boolean description: 'Indicates whether the Content is redacted for the requesting user. ' is_private: type: boolean description: 'Indicates whether the Content is set to private. ' show_code_name: type: boolean description: 'If `is_ghost` is true and `show_code_name` is true then the `name` property is a "code name" for the piece of Content. The user must request access to the Content to see the proper name. ' default_snapshot_url: type: - string - 'null' description: A URL that serves up the default snapshot preview of this Content. live_url: type: - string - 'null' description: The live URL to published Content. scheduled_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time. The date and time when the Content is scheduled to get published. If the Content has not been explicitly scheduled then this date is based on that of the Moment the Content lives within. ' start_interval: type: - string - 'null' description: 'An ISO8601 interval, relative to the start of the related Moment''s schedule, representing the explicitly chosen start datetime of the Content. Values are normalized to a seconds-denominated interval (e.g. `PT86400S`). Null when no specific time has been chosen for the Content — in that case `scheduled_at` falls back to the start of the Moment''s schedule. ' takedown_scheduled_at: type: - string - 'null' format: date-time description: 'An ISO8601 date-time. The date and time when the Content is scheduled to get taken down. ' post_data: type: - object - 'null' description: 'A hash that can store any metadata associated with the Content. ' additionalProperties: true publishing_mode: type: - string - 'null' description: The way in which the Content will be published. post_state: type: - string - 'null' description: The state of the Content in the workflow process. enum: - published - held - failed - publishing - dispatched - dispatching - approved - pending created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true service_id: type: integer relationships: type: object required: - account - approval_phase_group - asset_references - brand - budget - delivery_record - inherited_labels - label_sets - labels - links - moment - placement - post_components - post_options - post_type - post_type_options - rich_text_document - service - stories - user additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account approval_phase_group: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - phase-groups asset_references: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand budget: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - budget delivery_record: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - delivery_record inherited_labels: allOf: - type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - description: 'Only inherited labels. See the [Labels Overview](/api/documentation/v2#tag/Labels/Labels-Overview) for information on inheritance. ' label_sets: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label_set labels: allOf: - type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label - description: 'All labels (inherited or explicitly set). See the [Labels Overview](/api/documentation/v2#tag/Labels/Labels-Overview) for information on inheritance. ' links: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - link moment: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - moment placement: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement post_components: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_component post_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_option post_type: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_type post_type_options: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_option rich_text_document: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string format: uuid type: type: string enum: - rich_text_document service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service stories: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - story user: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - user links: type: object additionalProperties: false properties: web_url: type: string - title: account type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - account attributes: type: object required: - name - uuid additionalProperties: false properties: name: type: string uuid: type: string format: uuid relationships: type: object required: - service - brand - dispatch_provider_account - placements additionalProperties: false properties: service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand dispatch_provider_account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - dispatch_provider_account placements: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement '404': description: Placement not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status delete: tags: - Accounts operationId: DeletePlacementV0 summary: Delete placement security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: account_id in: path required: true description: The ID of the account to fetch placements for schema: type: string - name: id in: path required: true description: The ID of the placement to show/update/destroy schema: type: string responses: '204': description: Placement successfully deleted '404': description: Placement not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status /accounts/v2: get: tags: - Accounts operationId: ReadAccountsV2 summary: Get all accounts available to the authenticated user security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: brand_id description: The ID of the Brand (a.k.a. Workspace) for which accounts should be retrieved. in: query required: true schema: type: string - name: service_id description: A service ID by which to filter accounts. in: query required: false schema: type: string - name: include in: query required: false description: A comma separated list of related objects to include schema: type: array items: type: string enum: - service - service.asset_reference - brand - brand.primary_label_set - brand.accounts - dispatch_provider_account - placements style: form explode: false - name: page description: Specify an offset and limit for pagination in: query required: false schema: type: object properties: limit: type: integer default: 50 offset: type: integer style: deepObject explode: true responses: '200': description: A collection of accounts content: application/json: schema: type: object required: - data properties: data: type: array items: title: account type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - account attributes: type: object required: - name - uuid additionalProperties: false properties: name: type: string uuid: type: string format: uuid relationships: type: object required: - service - brand - dispatch_provider_account - placements additionalProperties: false properties: service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand dispatch_provider_account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - dispatch_provider_account placements: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement included: type: array items: oneOf: - title: service type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - service attributes: type: object required: - color - content_name - icon_name - name - system_name - uuid - web_modules_channel additionalProperties: false properties: color: type: string description: A hex color value with leading hash symbol intact content_name: type: string description: The default name of content for this service created_at: type: string format: date-time description: An ISO8601 date-time indicating when the service was created. readOnly: true has_placements: type: - boolean - 'null' description: Indicates if the service supports placements capability icon_name: type: - string - 'null' icon_path: type: - string - 'null' is_active: type: boolean description: Indicates active status of the service is_visible: type: boolean description: Indicates visibility of the service name: type: string system_name: type: string updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the service was last updated. readOnly: true uuid: type: string format: uuid web_modules_channel: type: - boolean - 'null' description: Indicates if the service is of the category "web modules" relationships: type: object required: - accounts - asset_reference - brand - post_types additionalProperties: false properties: accounts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account asset_reference: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference brand: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand post_types: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - post_type - title: brand type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - brand meta: type: - object - 'null' description: Metadata around the Brand object properties: user_is_member: type: boolean description: Boolean that represents whether the requesting user is a member of the brand. attributes: type: object required: - slug - name - uuid - start_of_week - timezone additionalProperties: false properties: uuid: type: string format: uuid description: A unique identifier for the workspace. created_at: type: string format: date-time description: An ISO8601 date-time. readOnly: true updated_at: type: string format: date-time description: An ISO8601 date-time indicating when the user was last updated. readOnly: true slug: type: string description: The slug for the Brand/Workspace. This is a url-safe name for the Workspace. name: type: string description: The name of the Workspace. start_of_week: type: number enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: 'The default start weekday index for the week view Calendar and for Plans. Specifies the days in a week, 0 to 6 (Sunday to Saturday). 0 (Sunday) is the default. With regards to the week view Calendar, values greater than 1 will be considered the same as 1.' timezone: type: string description: The IANA time zone identifier for the default time zone used when creating resources in the Brand/Workspace (e.g. America/New_York). relationships: type: object required: - primary_label_set - accounts - logo - dispatch_providers additionalProperties: false properties: primary_label_set: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - label_set accounts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account logo: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - asset_reference dispatch_providers: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - dispatch_provider - title: dispatch_provider_account type: object required: - id - type - attributes additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - dispatch_provider_account attributes: type: object additionalProperties: false properties: {} - title: placement type: object required: - relationships - id - attributes - type additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - placement relationships: type: object additionalProperties: false properties: account: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - account posts: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - content attributes: type: object required: - name additionalProperties: false properties: name: type: string position: type: - number - 'null' meta: type: object required: - total properties: total: type: integer '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status /accounts/v2/{account_id}: get: tags: - Accounts operationId: ReadAccountV2 summary: Get the specified account security: - oauth2: - offline_access - api_key: - Session-Token parameters: - name: account_id in: path required: true description: The ID of the account to fetch. schema: type: string - name: include in: query required: false description: A comma separated list of related objects to include schema: type: array items: type: string enum: - service - service.asset_reference - brand - brand.primary_label_set - brand.accounts - dispatch_provider_account - placements style: form explode: false responses: '200': description: The requested account content: application/json: schema: type: object required: - data properties: data: title: account type: object required: - id - type - attributes - relationships additionalProperties: false properties: id: type: string pattern: ^[0-9]+$ type: type: string enum: - account attributes: type: object required: - name - uuid additionalProperties: false properties: name: type: string uuid: type: string format: uuid relationships: type: object required: - service - brand - dispatch_provider_account - placements additionalProperties: false properties: service: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - service brand: type: object required: - data additionalProperties: false properties: data: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - brand dispatch_provider_account: type: object required: - data additionalProperties: false properties: data: type: - object - 'null' required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - dispatch_provider_account placements: type: object required: - data additionalProperties: false properties: data: type: array items: type: object required: - id - type additionalProperties: false properties: id: type: string type: type: string enum: - placement '400': description: Bad request content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '403': description: Forbidden content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status '404': description: Not found content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: status: type: string title: type: string detail: type: string required: - status components: securitySchemes: oauth2: type: oauth2 description: This API uses OAuth 2.0 with the authorization code grant flow. You can find more detailed authentication instructions in the [Authentication Strategies](/api/documentation#section/Authentication-Strategies/OAuth-2.0) section. flows: authorizationCode: authorizationUrl: /oauth2/auth tokenUrl: /oauth2/token scopes: offline_access: Include this scope if you wish to receive a refresh token api_key: type: apiKey description: (Deprecated) This API also supports authentication via an API or session token set in the request headers. in: header name: Session-Token x-tagGroups: - name: JSON:API tags: - Accounts - Activities - Annotations - Asset Reference Options - Asset Reference Usage Rights Options - Asset References - Assets - Brand Settings - Brands - Checkpoints - Content - Delivery Records - Label Sets - Labels - Messages - Moments - Phase Items - Placements - Post Types - Privacy - Reactions - Rich Texts - Services - Stamps - Stories - Url Uploads - User Domain Views - Users - Workflows - name: Other tags: - Budgets - URL Previews - Search - Stories V1 - name: ⚠️ Unstable tags: [] - name: Additional Resources tags: - secondary_resources