Signup Flow

Signup Flow

A Signup Flow is a publication's on-site subscriber flow — the widget (or hosted page) that greets new subscribers and walks them through recommendations, an optional survey, and offers. Each publication has exactly one, so this is a singleton resource.

Get signup flow

GET https://api.sparkloop.app/v3/publications/:publication_uuid/tools/signup_flow

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

Query Parameters

Name	Type	Description
expand	String	stats to include per-step performance.
from	String	Start date (YYYY-MM-DD) for stats.
to	String	End date (YYYY-MM-DD) for stats.

200: OK

{
  "signup_flow": <Signup Flow Object>
}

404: Not Found

{
  "error": "Resource not found."
}

Enable recommendations stage

POST https://api.sparkloop.app/v3/publications/:publication_uuid/tools/signup_flow/recommendations/activation

Shows the recommendations stage to new subscribers.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

200: OK

{
  "signup_flow": <Signup Flow Object>
}

404: Not Found

{
  "error": "Resource not found."
}

Disable recommendations stage

DELETE https://api.sparkloop.app/v3/publications/:publication_uuid/tools/signup_flow/recommendations/activation

Hides the recommendations stage. At least one of recommendations or offers must remain enabled.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

200: OK

{
  "signup_flow": <Signup Flow Object>
}

404: Not Found

{
  "error": "Resource not found."
}

422: Unprocessable Entity

{
  "error": "You must display either recommendations or offers"
}

Enable offers stage

POST https://api.sparkloop.app/v3/publications/:publication_uuid/tools/signup_flow/offers/activation

Shows the offers stage to new subscribers.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

200: OK

{
  "signup_flow": <Signup Flow Object>
}

404: Not Found

{
  "error": "Resource not found."
}

Disable offers stage

DELETE https://api.sparkloop.app/v3/publications/:publication_uuid/tools/signup_flow/offers/activation

Hides the offers stage. At least one of recommendations or offers must remain enabled.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

200: OK

{
  "signup_flow": <Signup Flow Object>
}

404: Not Found

{
  "error": "Resource not found."
}

422: Unprocessable Entity

{
  "error": "You must display either recommendations or offers"
}

Enable survey stage

POST https://api.sparkloop.app/v3/publications/:publication_uuid/tools/signup_flow/survey/activation

Shows the survey stage to new subscribers. The publication must already have a survey.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

200: OK

{
  "signup_flow": <Signup Flow Object>
}

404: Not Found

{
  "error": "Resource not found."
}

422: Unprocessable Entity

{
  "error": "Display survey can't be enabled without a survey"
}

Disable survey stage

DELETE https://api.sparkloop.app/v3/publications/:publication_uuid/tools/signup_flow/survey/activation

Hides the survey stage.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

200: OK

{
  "signup_flow": <Signup Flow Object>
}

404: Not Found

{
  "error": "Resource not found."
}