Skip to main content
PATCH
Update alternative names

Authorizations

Authorization
string
header
required

A Searchable API key, created under Manage Account → Integrations → API Keys. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

Body

application/json

The change to make: add and/or remove, or replace on its own.

add
string[]

Names to add. A name the project already has is left as it is.

Maximum array length: 25
Maximum string length: 120
remove
string[]

Names to remove, matched ignoring case. Each must be one of the project's alternative names.

Maximum array length: 25
Maximum string length: 120
replace
string[]

The whole list the project should have; names not in it are removed. An empty list removes every name. Not combined with add or remove.

Maximum array length: 25
Maximum string length: 120

Response

Alternative names updated.

success
boolean
required
alternativeNames
string[]
required

The project's alternative names after the change.

added
string[]
required

Names this request added.

removed
string[]
required

Names this request removed, as they were saved.

alreadyPresent
string[]
required

Names asked for that the project already had; nothing changed for them.