Update SOA details

Update SO details.

Required permissions: SOA

put

/tenants/{tenantUid}/soas/{soaUid}

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

soaUidstringRequired

Reference to a SOA.

Pattern: ^[A-Za-z0-9-_]+

Body

externalIdstringOptional

namestringOptional

Responses

200

Example response

application/json

namestringRequired

externalIdstringRequired

soaUidstringRequiredPattern: ^[A-Za-z0-9-_]+

createdAtstring · date-timeRequired

createdBystringRequired

lastModifiedAtstring · date-timeRequired

lastModifiedBystringRequired

put/tenants/{tenantUid}/soas/{soaUid}

PUT /v2/tenants/{tenantUid}/soas/{soaUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "externalId": "text",
  "name": "text"
}

200

Example response

{
  "name": "text",
  "externalId": "text",
  "soaUid": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "text",
  "lastModifiedAt": "2026-01-01T00:00:00.000Z",
  "lastModifiedBy": "text"
}