add note

1 min

POST

https://api.upstartcommerce.com/v1/customer/{customerId}/note

This endpoint allows administrators to add a note about a consumer.

Authorized permissions:

customer.update

customerIdstringUnique identifier for the consumer that the call should be interacting with.

x-upstart-tenantstringTenant identifier associated with the site this call is for.

x-upstart-sitestringUnique identifier for the site.

bodyobjectText for the note.

201<p>Created - Note added to the consumer's account.</p>

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

curl --request POST \
     --url https://api.upstartcommerce.com/v1/customer/{customerId}/note \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "txt": ""
     }'