MAmaritime
end-users

Upsert End User

Creates the end user, or updates the fields sent. 201 on create, 200 after.

put/api/v1/end-users/{external_id}

Request

  • Base URL
    https://api.maritime.sh (the document declares no server; this is the origin it was published from)
  • URL
    https://api.maritime.sh/api/v1/end-users/{external_id}
  • Auth
    HTTP bearer

Path parameters

external_idstring required

Request body

displayNamestring nullable
metadataobject nullable
tagsstring[] nullable

Response

Successful Response

idstring required
externalIdstring required
displayNamestring nullable
metadataobject
tagsstring[]
statusstring required
policyobject nullable
agentCountinteger
aiSpendCents30dnumber
messageCountinteger
activity14dinteger[]
createdAtstring date-time required
updatedAtstring date-time required
lastActiveAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.