Delete Employment Types

    Deletes employment types.

    Note

    • The useEmploymentType parameter for the domain should be set to "true" to delete employment types.

    API Type

    Server API

    Request URL

    • Live environment: https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/employtypes/{externalKey}
    • Testing environment: https://sandbox-apis.worksmobile.com/{API ID}/organization/v2/domains/{domainId}/employtypes/{externalKey}

    HTTP Method

    DELETE (Content-Type: */*)

    Path Parameters

    Parameter Type Length Required Description
    domainId Integer Y Domain ID
    externalKey String 100 characters Y An external key for employment types

    Request Example

    DELETE https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/employtypes/EX123
    

    Response

    It returns HTTP status 200 with no response when the API call is successful.

    Error Code

    It returns an error code and message when the API call fails.
    Refer to Organization Integration REST API Error Codes for details.