Update a form - Auth0 Docs

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.forms.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.forms.update("id", {});
}
main();

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateFormRequestContent{}
    mgmt.Forms.Update(
        context.TODO(),
        "id",
        request,
    )
}

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Forms.UpdateAsync(
            id: "id",
            request: new UpdateFormRequestContent()
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateFormRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.forms().update(
            "id",
            UpdateFormRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Forms\Requests\UpdateFormRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->forms->update(
    'id',
    new UpdateFormRequestContent([]),
);

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/forms/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "messages": {
    "errors": {},
    "custom": {}
  },
  "languages": {
    "primary": "<string>",
    "default": "<string>"
  },
  "translations": {},
  "nodes": [
    {
      "id": "<string>",
      "type": "FLOW",
      "config": {
        "flow_id": "<string>",
        "next_node": "<string>"
      },
      "alias": "<string>"
    }
  ],
  "start": {
    "hidden_fields": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "next_node": "<string>"
  },
  "ending": {
    "after_submit": {
      "flow_id": "<string>"
    },
    "resume_flow": true
  },
  "style": {
    "css": "<string>"
  }
}
'

{
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "messages": {
    "errors": {},
    "custom": {}
  },
  "languages": {
    "primary": "<string>",
    "default": "<string>"
  },
  "translations": {},
  "nodes": [
    {
      "id": "<string>",
      "type": "FLOW",
      "config": {
        "flow_id": "<string>",
        "next_node": "<string>"
      },
      "coordinates": {
        "x": 0,
        "y": 0
      },
      "alias": "<string>"
    }
  ],
  "start": {
    "hidden_fields": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "next_node": "<string>",
    "coordinates": {
      "x": 0,
      "y": 0
    }
  },
  "ending": {
    "redirection": {
      "target": "<string>",
      "delay": 5
    },
    "after_submit": {
      "flow_id": "<string>"
    },
    "coordinates": {
      "x": 0,
      "y": 0
    },
    "resume_flow": true
  },
  "style": {
    "css": "<string>"
  },
  "embedded_at": "2023-12-25",
  "submitted_at": "2023-12-25"
}

PATCH

https://{tenantDomain}/api/v2

forms

{id}

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.forms.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.forms.update("id", {});
}
main();

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.UpdateFormRequestContent{}
    mgmt.Forms.Update(
        context.TODO(),
        "id",
        request,
    )
}

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Forms.UpdateAsync(
            id: "id",
            request: new UpdateFormRequestContent()
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.UpdateFormRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.forms().update(
            "id",
            UpdateFormRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Forms\Requests\UpdateFormRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->forms->update(
    'id',
    new UpdateFormRequestContent([]),
);

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/forms/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "messages": {
    "errors": {},
    "custom": {}
  },
  "languages": {
    "primary": "<string>",
    "default": "<string>"
  },
  "translations": {},
  "nodes": [
    {
      "id": "<string>",
      "type": "FLOW",
      "config": {
        "flow_id": "<string>",
        "next_node": "<string>"
      },
      "alias": "<string>"
    }
  ],
  "start": {
    "hidden_fields": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "next_node": "<string>"
  },
  "ending": {
    "after_submit": {
      "flow_id": "<string>"
    },
    "resume_flow": true
  },
  "style": {
    "css": "<string>"
  }
}
'

{
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "messages": {
    "errors": {},
    "custom": {}
  },
  "languages": {
    "primary": "<string>",
    "default": "<string>"
  },
  "translations": {},
  "nodes": [
    {
      "id": "<string>",
      "type": "FLOW",
      "config": {
        "flow_id": "<string>",
        "next_node": "<string>"
      },
      "coordinates": {
        "x": 0,
        "y": 0
      },
      "alias": "<string>"
    }
  ],
  "start": {
    "hidden_fields": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "next_node": "<string>",
    "coordinates": {
      "x": 0,
      "y": 0
    }
  },
  "ending": {
    "redirection": {
      "target": "<string>",
      "delay": 5
    },
    "after_submit": {
      "flow_id": "<string>"
    },
    "coordinates": {
      "x": 0,
      "y": 0
    },
    "resume_flow": true
  },
  "style": {
    "css": "<string>"
  },
  "embedded_at": "2023-12-25",
  "submitted_at": "2023-12-25"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The ID of the form to update.

Maximum string length: 30

Body

name

string

Required string length: 1 - 150

messages

object | null

Show child attributes

languages

object | null

Show child attributes

translations

object | null

Show child attributes

nodes

object[] | null

Option 1
Option 2
Option 3

Show child attributes

start

object | null

Show child attributes

ending

object | null

Show child attributes

style

object | null

Show child attributes

Response

Form successfully updated.

string<form-id>

required

Maximum string length: 30

name

string

required

Required string length: 1 - 150

created_at

string<date-time>

required

updated_at

string<date-time>

required

messages

object

Show child attributes

languages

object

Show child attributes

translations

object

Show child attributes

nodes

object[]

Option 1
Option 2
Option 3

Show child attributes

start

object

Show child attributes

ending

object

Show child attributes

style

object

Show child attributes

embedded_at

string<date>

submitted_at

string<date>