VEverbiflow
sequences

Replace Sequence Assignments

put/api/sequences/{sequence_id}/assignments

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/sequences/{sequence_id}/assignments
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Path parameters

sequence_idstring required

Request body

expected_assignments_versioninteger required
user_idsstring[]

Response

Successful Response

assignments_versioninteger

Monotonic campaign-assignment version.

attempted_countinteger nullable

Provider send attempts, including confirmed sends and terminal failures.

bounce_ratenumber nullable

Terminal hard bounces divided by eligible sent emails.

click_ratenumber nullable

Eligible email clicks divided by eligible sent emails.

created_atstring date-time required

Time when the campaign was created.

enrolled_countinteger nullable

People admitted to campaign runtime.

failed_countinteger nullable

Latest unrecovered terminal send failures.

failure_ratenumber nullable

Terminal failures divided by attempted actions.

has_published_revisionboolean

Whether the campaign has an immutable published revision.

is_archivedboolean

Whether the campaign is archived.

open_ratenumber nullable

Eligible email opens divided by eligible sent emails.

operational_state'inactive' | 'active' | 'paused' required

Current campaign lifecycle state.

reply_ratenumber nullable

Eligible replies divided by eligible sent actions.

sent_countinteger nullable

Provider-confirmed outbound actions.

sequence_idstring required

Stable campaign id.

sequence_namestring required

Human-readable campaign name.

source_registry_versioninteger

Monotonic operational source-registry version.

updated_atstring date-time required

Time when the campaign last changed.

validation_error_countinteger

Number of publication-blocking validation errors on the current draft.

Changes

No recorded changes to this operation across all 1 revision of this API.