Skip to main content
Developer Marketing Signatures1.0.0-beta.1

Update a signature name and slug

Replaces the display name and URL slug at the expected revision. A token changing the URL slug of a published signature also needs the publication scope.

PATCH/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:manage. Scopes are independent.

Conditional token scope marketing:signatures:publish. Required when changing a published signature’s URL slug.

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)Required

Stable signature UUID.

Query parameters

None documented.

Header parameters

None documented.

Request body

application/json · Required

Supply the expected revision, new display name and slug.

revisionintegerRequired

Minimum: 1. Maximum: 2147483646.

namestringRequired

Visible signature name. Surrounding whitespace is removed. Control and bidirectional formatting characters are rejected. Minimum length: 1. Maximum length: 120.

slugstringRequired

Unique URL slug within the Space. Minimum length: 3. Maximum length: 64. Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional

Server-generated ID to include in a support request.

200

The committed metadata revision.

Response headers

RateLimit-LimitintegerOptional

Per-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-RemainingintegerOptional

Requests 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-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

signatureIdstring (uuid)Required

No field description supplied.

revisionintegerRequired

Minimum: 1. Maximum: 2147483647.

updatedAtstring (date-time)Required

No field description supplied.

publishedAtstring | null (date-time)Required

No field description supplied.

400

The request fields, selectors or resource identifiers are invalid.

application/json

statusCodeintegerRequired

Minimum: 400. Maximum: 599.

statusMessagestringOptional

A safe explanation suitable for display.

dataobjectRequired

No field description supplied.

401

A valid Developer API bearer token is required.

Response headers

WWW-AuthenticatestringOptional

Bearer authentication challenge. A rejected token can include the invalid_token error.

application/json

Uses the same response body schema as HTTP 400.

402

An active eligible Marketing entitlement is required.

application/json

Uses the same response body schema as HTTP 400.

403

The token scope, current Space role or plan allowance does not permit this operation.

application/json

Uses the same response body schema as HTTP 400.

404

The resource was not found in the token Space or the operation 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 revision, connection, quota reservation or current resource state conflicts with the request.

application/json

Uses the same response body schema as HTTP 400.

413

The request body exceeds the permitted size.

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

The request rate limit was reached. Edge traffic limits can also return 429.

Response headers

RateLimit-LimitintegerOptional

Per-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-RemainingintegerOptional

Requests 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-ResetintegerOptional

Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

Retry-AfterintegerOptional

Seconds 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 operation is temporarily unavailable.

application/json

Uses the same response body schema as HTTP 400.

Was this helpful?