200Successful Response
Schema: SuccessEnvelope_SopSuggestionListResponse_
successbooleanmessagestringcodestringdataSopSuggestionListResponse
/api/v1/agents/sops/suggestionsSOPs worth writing for this business, ranked, from what it has connected (bank and card feeds, Shopify, Stripe, QuickBooks, payroll), its bill and invoice volume, open periods, and the SOPs and roles it already has. Each names a starter template and an owner role; already_have marks one a draft or live SOP covers.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
include_existingbooleandefault: FalseAlso return suggestions an SOP already covers
Schema: SuccessEnvelope_SopSuggestionListResponse_
successbooleanmessagestringcodestringdataSopSuggestionListResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.