Save a signup form's text in a language

PUT

/api/v1/workspaces/{workspace}/forms/{form}/copy/{language}

curl --request PUT \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/copy/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "afterSubmit": "example", "button": "example", "consentText": "example", "description": "example", "fields": { "additionalProperty": "example" }, "heading": "example" }'

• Your ReputeCast public URL

Permission: forms:edit

In the form’s own language this is its content and consent text. Changing a consent text starts a new version of it in that language; consent evidence keeps the version and language shown.

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

form

required

Form id

string format: uuid

Form id

language

required

A workspace language (es)

string

<= 35 characters /^[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8})*$/

A workspace language (es)

Request Body^required

Media typeapplication/json

object

afterSubmit

required

What the form says after a signup

string

<= 300 characters

button

required

string

<= 40 characters

consentText

required

string

<= 600 characters

description

required

string

<= 500 characters

fields

required

object

<= 20 properties

key

additional properties

string

heading

required

string

<= 120 characters

Example ^generated

{
  "afterSubmit": "example",
  "button": "example",
  "consentText": "example",
  "description": "example",
  "fields": {
    "additionalProperty": "example"
  },
  "heading": "example"
}

Responses

200

OK

Media typeapplication/json

object

consentChangedAt

string format: date-time

consentChangedBy

required

string

consentVersion

required

integer format: int64

copyLanguage

required

The language the form is written in

string

fallback

required

The language the form shows where one isn’t Live

string

fields

required

Array<object>

object

key

required

string

source

required

Its label in the form’s own language

string

fixedLanguage

required

string

formId

required

string

languageMode

required

string

Allowed values: page browser fixed

languages

required

Array<object>

object

at

string format: date-time

by

required

string

code

required

string

consentFor

required

integer format: int64

consentReview

required

The form’s own consent text changed since: Review the translation

boolean

consentVersion

required

integer format: int64

copy

required

object

afterSubmit

required

What the form says after a signup

string

<= 300 characters

button

required

string

<= 40 characters

consentText

required

string

<= 600 characters

description

required

string

<= 500 characters

fields

required

object

<= 20 properties

key

additional properties

string

heading

required

string

<= 120 characters

defaultAfterSubmit

required

string

evidence

object

at

required

string format: date-time

contactId

required

string

name

required

string

version

required

string

isDefault

required

boolean

isSource

required

boolean

labels

required

object

at

string format: date-time

by

required

Who wrote them last

string

shipped

required

boolean

total

required

integer format: int64

written

required

Labels with text in the language (all of them when they ship)

integer format: int64

missing

required

integer format: int64

name

required

string

native

required

string

status

required

string

Allowed values: live incomplete not_set_up

total

required

integer format: int64

written

required

integer format: int64

Example

{
  "languageMode": "page",
  "languages": [
    {
      "code": "es",
      "evidence": {
        "version": "v1"
      },
      "name": "Spanish",
      "native": "Español",
      "status": "live"
    }
  ]
}

default

Error

Media typeapplication/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}