# Invite User To Organization

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Invite User To Organization"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/api/v1/organization/{organization_id}/invitation"}
  context={"endpoint"}
>
  
</MethodEndpoint>

Sends an email to the user inviting them to your deepset organization.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"description":"A unique identifier of the organization. You can obtain the organization ID from the [Get Users Me](https://docs.cloud.deepset.ai/reference/read_users_me_api_v1_me_get)  endpoint.","in":"path","name":"organization_id","required":true,"schema":{"description":"A unique identifier of the organization. You can obtain the organization ID from the [Get Users Me](https://docs.cloud.deepset.ai/reference/read_users_me_api_v1_me_get)  endpoint.","title":"Organization ID","type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"description":"The definition of the user you want to invite to the organization.","properties":{"email":{"description":"Email of a user.","title":"Email","type":"string"},"family_name":{"description":"Family name of a user.","title":"Family name","type":"string"},"given_name":{"description":"Given name of a user.","title":"Given name","type":"string"},"role":{"description":"Role of the user. This can be a custom role or one of the default roles.","title":"User Role","type":"string"},"workspace_ids":{"default":[],"description":"A list of unique identifiers for workspaces.","items":{"format":"uuid","type":"string"},"title":"Workspace IDs","type":"array"}},"required":["given_name","family_name","email","role"],"title":"User Invitation","type":"object"}}},"required":true}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"content":{"application/json":{"schema":{}}},"description":"The user has been invited to the organization."},"402":{"description":"Inviting users is not available on the free plan. To invite team members, please upgrade to a paid plan."},"409":{"description":"The user already belongs to the organization."},"422":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"ctx":{"title":"Context","type":"object"},"input":{"title":"Input"},"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"title":"Location","type":"array"},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object"},"title":"Detail","type":"array"}},"title":"HTTPValidationError","type":"object"}}},"description":"Validation Error"},"503":{"description":"Something went wrong during signup."}}}
>
  
</StatusCodes>