Move and entity to a different program

POST

admin

move

{entity_id}

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

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

Authorizations

X-HYS-API-Key

string

header

required

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

Path Parameters

entity_id

integer

required

Entity ID of the entity

Body

application/json

Data required to move the entity

entity_id

string

required

client_id

string

required

new_program

string

Response

Entity moved successfully

message

string

Example:

"Entity successfully moved."

Move Multiple EntitiesHandles the process of moving multiple entities to a different program, * including updating entity records and clearing relevant caches.

Move and entity to a different program

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

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