Move Multiple Entities - HelpYouSponsor Docs

PUT

/

admin

/

entities

/

move

Move Multiple Entities

curl --request PUT \
  --url https://api.helpyousponsor.com/v1/admin/entities/move \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "entity_ids": [
    "1,2"
  ],
  "client_id": "<string>",
  "new_program": "<string>"
}
'

{
  "message": "Entities successfully moved."
}

Authorizations

X-HYS-API-Key

string

header

required

API key generated from Developer Settings. Format: hys_...

Body

application/json

Data required to move multiple entities

entity_ids

integer[]

required

client_id

string

new_program

string

Response

Entities moved successfully

message

string

Example:

"Entities successfully moved."

curl --request PUT \
  --url https://api.helpyousponsor.com/v1/admin/entities/move \
  --header 'Content-Type: application/json' \
  --header 'X-HYS-API-Key: <api-key>' \
  --data '
{
  "entity_ids": [
    "1,2"
  ],
  "client_id": "<string>",
  "new_program": "<string>"
}
'

{
  "message": "Entities successfully moved."
}