API Reference

Update a PostCampaign.

put
https://api.prtmb.com/api/v2/accounts//post-campaigns/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
required

This parameter indicates which Account owns the collections and resources reference by the request.

As a convenience, the slug me may be used in place of the account_id in any URL where it is
required. When me is used it will be replaced with the account_id of the current User.

string
required

PostCampaign ID

Body Params

Success

Update a PostCampaign.

integer

An integer representing the number of seconds the campaign is expected to be active before
the expires_at date/time. For example, if the duration value is 3600 and the expires_at
value is 2021-03-31T20:15:00Z, the campaign should be active from 2021-03-31T19:15:00Z to
2021-03-31T20:15:00Z. This field is used to preserve the original input from the user and
as a sanity check to ensure there is enough time to execute the campaign.

string | null

An ISO 8601 format date and time indicating when this campaign offer expires.

string | null

Alternate text describing the image at image_src.

string | null

A URL of an image that should be included with the message_text.

string | null

A URL that should be included after the message_text.

string

The main text of the campaign message.

string

A unique name for this campaign

recipient_ids
array of uuids
Defaults to

A list of audience_membership_ids that should receive this campaign message.

recipient_ids
uuid | null

The unique ID of the audience segment that should receive this campaign message.

boolean

Indicates the campaign should start sending as soon as possible when true. Note: published_at must
also be set before send_as_soon_as_possible becomes active.

string | null

An ISO 8601 format date and time indicating when this campaign should start sending.

boolean
Defaults to true

A boolean indicating if this campaign should be sent to all audience_memberships.

string

A text field indicating a valid timezone. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for a list of valid timezones.

string | null

A unique and URL safe string used to identify this campaign in kebab format
(e.g. lower-case-with-dashes). Slug must be unique within an account.

Response

Callback

Updated over 4 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 4 years ago