Edit Policy

PATCH /policies/{policyId}

Edit Policy

cURL

curl --request PATCH \
  --url https://api.example.com/policies/{policyId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "acceptedEmailDomains": [
    "<string>"
  ],
  "maximumNumberOfBikes": 2
}
'

200

Example

{}

Path Parameters

policyId · string · required

the policy's id

Query Parameters

whenAt · string

Optional: the whenAt datetime

branchId · string

Optional: the branchId

Body

application/json

customFields · object[]

custom fields per product

Show child attributes

name · string

Optional: Name of the entity

invoicingConfig · object

the policy's invoicing configuration

Show child attributes

periodDuration · object

the policy's period duration

Show child attributes

acceptedEmailDomains · string[]

the child policy's customer accepted email domains

acceptedQuoteOptions · object

Show child attributes

maximumNumberOfBikes · number

max number of bike

Required range: x >= 1

Response

200

application/json

The response is of type object.