API DocumentationManufacturer customer organisation controller

Upsert customer organisation metadata by key

PUT
/api/manufacturer/v1/organisation/{organisationId}/metadata/key/{metadataKey}

Sets the value for a metadata key on a customer organisation, creating the entry if it does not already exist. Intended for external systems that track their own key but do not know the corresponding internal metadata ID.

Authorization

Phasio API Bearer Token
AuthorizationBearer <token>

In: header

Path Parameters

organisationId*integer

ID of the organisation

metadataKey*string

Metadata key to set

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://example.com/api/manufacturer/v1/organisation/1/metadata/key/shopifyCustomerId" \  -H "Content-Type: application/json" \  -d '{    "value": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "metadataKey": "string",  "value": "string"}
Empty

Last updated on