getstarted.ae

Remove a participant

DELETEhttps://api.getstarted.ae/v1/incorporations/{incorporationId}/participants/{participantId}

Removes the participant from the incorporation. The underlying person or entity is kept.

Path parameters

  • incorporationIdstringrequired

    ID of the incorporation, e.g. inc_01J9ZK7C3VYB5N.

  • participantIdstringrequired

    ID of the participant, e.g. par_01J9ZKE7LB2H6J.

Responses

  • 200OK. Returns the object shown in the example.
  • 404resource_not_found No participant with that ID exists in this environment.
  • 409incorporation_locked The incorporation has been submitted.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X DELETE "https://api.getstarted.ae/v1/incorporations/inc_01J9ZK7C3VYB5N/participants/par_01J9ZKE7LB2H6J" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY"
Response · 200
{
  "id": "par_01J9ZKE7LB2H6J",
  "object": "participant",
  "deleted": true
}