organizations

Changed on

Creates a CTA.

post/v1/{+parent}/ctas

Request

  • Base URL: https://webcontentpublisher.googleapis.com
  • URL: https://webcontentpublisher.googleapis.com/v1/{+parent}/ctas
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system)

Path parameters

parentstring required

Required. The parent publication resource where this CTA will be created. Format: organizations/{organization}/publications/{publication}.

Query parameters

ctaIdstring

Optional. The unique identifier of the CTA to create. If not specified, the server will generate a random CTA ID.

Request body

displayNamestring

Required. The user-visible display name of the CTA.

namestring

Identifier. The resource name of the Cta. Format: organizations/{organization}/publications/{publication}/ctas/{cta}

state'STATE_UNSPECIFIED' | 'DRAFT' | 'ACTIVE'

Output only. The current state of this CTA.

type'TYPE_UNSPECIFIED' | 'NEWSLETTER_SIGNUP' | 'SURVEY'

Required. The type of this CTA.

Response

Successful response

Changes

  • c51436940f54Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

  • 534f2cc7e02fRevision changes
    • info

      the security scope https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/webcontentpublisher.publications.manage.system was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage was removed from the endpoint's security scheme Oauth2c

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status