/api/v1/places/{id}/secrets/{fieldKey} (PUT)

PUT

/api/v1/places/{id}/secrets/{fieldKey}

const url = 'https://example.com/api/v1/places/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/secrets/example';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"value":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/v1/places/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/secrets/example \
  --header 'Content-Type: application/json' \
  --data '{ "value": "example" }'

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

fieldKey

required

string

>= 1 characters <= 64 characters

Request Body^required

application/json

object

value

required

string

>= 1 characters <= 4096 characters

Example^generated

{
  "value": "example"
}

Responses

200

Default Response

/api/v1/places/{id}/secrets/{fieldKey} (PUT)

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Request Body^required

Example^generated