ATatlassian
Servicedesk

Invite customer

Changed on

This method invites a customer to a specified service desk by sending them an email invitation, creating a new customer account if one does not already exist. The display name does not need to be unique. The record's identifiers, name and key, are automatically generated from the request details.

Permissions required: Jira Administrator Global permission & Service desk administrator

post/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/invite

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/invite
  • Auth
    OAuth 2
    Authorization code: https://auth.atlassian.com/authorize
    Token URL: https://auth.atlassian.com/oauth/token scopes: manage:servicedesk-customer

Path parameters

serviceDeskIdstring required

The ID of the service desk to which the newly created customer should be added.

Query parameters

strictConflictStatusCodeboolean

Optional boolean flag to return 409 Conflict status code when a customer with the same email already exists.

Request body

displayNamestring

Customer's name for display in the UI.

emailstring

Customer's email address.

Response

Returns the customer details.

Changes