Replace a Marketing signature draft
Saves a complete draft at the supplied revision. The signature name, employee page address and publication state are preserved. Returns a receipt with the committed revision. After an interrupted response, use a read-scoped token to check the current draft before retrying.
/api/v1/marketing/signatures/{signatureId}Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.
Required token scope is marketing:signatures:write. Scopes are independent.
This operation uses 3 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute.
Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.
Authentication
Dashio developer token (HTTP Bearer) API authentication guide
Path parameters
signatureIdstring (uuid)RequiredStable signature ID from the inventory.
Query parameters
None documented.
Header parameters
None documented.
Request body
application/json · Required
Supply the complete version 1 configuration and the revision returned by the draft read. The JSON request is limited to 2 MiB.
revisionintegerRequiredRevision the replacement expects. Minimum: 1. Maximum: 2147483646.
draftConfigobjectRequiredVersion 1 company and field configuration, up to 1.5 MiB of serialized JSON. Employee-entered field values are absent.
Responses
Headers on every response
X-Request-Idstring (uuid)OptionalServer-generated ID to include in a support request.
200
Confirmation of the committed draft replacement.
Response headers
RateLimit-LimitintegerOptionalPer-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptionalRequests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptionalUnix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.
application/json
signatureIdstring (uuid)RequiredNo field description supplied.
revisionintegerRequiredRevision assigned to the committed draft. Minimum: 1.
updatedAtstring (date-time)RequiredNo field description supplied.
400
Invalid ID, unexpected query parameter, or invalid draft request.
application/json
statusCodeintegerRequiredMinimum: 400. Maximum: 599.
statusMessagestringOptionalA safe explanation suitable for display.
dataobjectRequiredNo field description supplied.
401
Developer token missing, invalid, expired or revoked.
Response headers
WWW-AuthenticatestringOptionalBearer authentication challenge. A rejected token can include the invalid_token error.
application/json
Uses the same response body schema as HTTP 400.
402
Current Marketing entitlement required.
application/json
Uses the same response body schema as HTTP 400.
403
The token lacks marketing:signatures:write or no longer has current Space write access.
application/json
Uses the same response body schema as HTTP 400.
404
The signature was not found in the token’s Space or Marketing is unavailable.
application/json
Uses the same response body schema as HTTP 400.
408
The request body could not be read before the deadline.
application/json
Uses the same response body schema as HTTP 400.
409
The signature revision changed. Read the current draft before retrying.
application/json
Uses the same response body schema as HTTP 400.
415
Content-Type must be application/json.
application/json
Uses the same response body schema as HTTP 400.
429
Token or Space rate limit exceeded. Edge traffic limits can also return 429.
Response headers
RateLimit-LimitintegerOptionalPer-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptionalRequests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptionalUnix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.
Retry-AfterintegerOptionalSeconds to wait before retrying, when the limiting policy supplies a retry time. Minimum: 1.
application/json
Uses the same response body schema as HTTP 400.
503
The API or signature data is temporarily unavailable.
application/json
Uses the same response body schema as HTTP 400.
Was this helpful?