# CreateEngagementInvitation


 This action creates an invitation from a sender to a single receiver to join an engagement. 

## Request Syntax


```
{
   "Catalog": "string",
   "ClientToken": "string",
   "EngagementIdentifier": "string",
   "Invitation": { 
      "Message": "string",
      "Payload": { ... },
      "Receiver": { ... }
   }
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [Catalog](#API_CreateEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-request-Catalog"></a>
 Specifies the catalog related to the engagement. Accepted values are `AWS` and `Sandbox`, which determine the environment in which the engagement is managed.   
Type: String  
Pattern: `[a-zA-Z]+`   
Required: Yes

 ** [ClientToken](#API_CreateEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-request-ClientToken"></a>
 Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.   
Type: String  
Pattern: `.{1,255}`   
Required: Yes

 ** [EngagementIdentifier](#API_CreateEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-request-EngagementIdentifier"></a>
 The unique identifier of the `Engagement` associated with the invitation. This parameter ensures the invitation is created within the correct `Engagement` context.   
Type: String  
Pattern: `eng-[0-9a-z]{14}`   
Required: Yes

 ** [Invitation](#API_CreateEngagementInvitation_RequestSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-request-Invitation"></a>
 The `Invitation` object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The `Payload` can be the `OpportunityInvitation`, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details, or `LeadInvitation`, which includes structures for customer information and interaction details.   
Type: [Invitation](API_Invitation.md) object  
Required: Yes

## Response Syntax


```
{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-response-Arn"></a>
 The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.   
Type: String  
Pattern: `arn:aws:partnercentral::[0-9]{12}:[a-zA-Z]+/engagement-invitation/engi-[0-9,a-z]{13}` 

 ** [Id](#API_CreateEngagementInvitation_ResponseSyntax) **   <a name="AWSPartnerCentral-CreateEngagementInvitation-response-Id"></a>
 Unique identifier assigned to the newly created engagement invitation.   
Type: String  
Pattern: `engi-[0-9,a-z]{13}` 

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
This error occurs when you don't have permission to perform the requested action.  
You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.    
 ** Reason **   
The reason why access was denied for the requested operation.
HTTP Status Code: 400

 ** ConflictException **   
This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.  
Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.  
HTTP Status Code: 400

 ** InternalServerException **   
This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.  
Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.  
Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.  
Suggested action: Review the [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) for the resource, and either reduce usage or request a quota increase.  
HTTP Status Code: 400

 ** ThrottlingException **   
This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.  
This error occurs when there are too many requests sent. Review the provided [Quotas](https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html) and retry after the provided delay.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by the service or business validation rules.  
Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.    
 ** ErrorList **   
A list of issues that were discovered in the submitted request or the resource state.  
 ** Reason **   
The primary reason for this validation exception to occur.  
+  *REQUEST\$1VALIDATION\$1FAILED:* The request format is not valid.

  Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
+  *BUSINESS\$1VALIDATION\$1FAILED:* The requested change doesn't pass the business validation rules.

  Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/partnercentral-selling-2022-07-26/CreateEngagementInvitation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/partnercentral-selling-2022-07-26/CreateEngagementInvitation)