Update Storefront Payout Mapping Group
PUT/api/storefront/payout-mappings/groups/:storefrontPayoutMappingGroup
Renames a group or changes its document type. The unposted payouts with lines in the group are rebuilt; skipped_posted_count is the number of posted payouts the change makes out of date (flagged for review, not rebuilt).
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token and the integrations.update permission. Open to API tokens with the accounting:write scope.
Body (both optional):
name(string, max 255).document_type: invoice or bill.
Returns 404 when the group does not exist.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.