Adding and removing people from organizations

Requests to add and remove people from organizations in your Ortto CDP are submitted via the methods and API endpoints shown on this page.

NOTE: Ortto customers who have their instance region set to Australia or Europe will need to use specific service endpoints relative to the region:

Australia: https://api.au.ap3api.com/
Europe: https://api.eu.ap3api.com/

For example: https://api.eu.ap3api.com/v1/<entity/endpoint>

All other Ortto users will use the default service endpoint (https://api.ap3api.com/).

Adding people to an organization

Here is a cURL example of adding people to an organization in Ortto:

shell
 curl --location\
     --request PUT 'https://api.ap3api.com/v1/organizations/contacts/add'\
     --header 'X-Api-Key: YOUR-API-KEY-HERE'\
     --header 'Content-Type: application/json'\
     --data-raw '{
        "inclusion_ids": ["006046bbb37f2e24cc56f200", "006046baa37f2e24cc56f122"],
	"organization_id": "106051701f79e14b592cee00"
      }'

The following fields are required:

Field	Description
inclusion_ids	A list of person_ids to be added to the organization.
organization_id	The organization to add the people to.

NOTE: You can add up to 3000 people per organization.

Removing people from an organization

Here is a cURL example of adding people to an organization in Ortto:

shell
 curl --location\
     --request PUT 'https://api.ap3api.com/v1/organizations/contacts/remove'\
     --header 'X-Api-Key: YOUR-API-KEY-HERE'\
     --header 'Content-Type: application/json'\
     --data-raw '{
        "inclusion_ids": ["006046bbb37f2e24cc56f200"],
	"organization_id": "106051701f79e14b592cee00"
      }'

The following fields are required:

Field	Description
inclusion_ids	A list of person_ids to be removed from the organization.
organization_id	The organization to remove people from.