DocumentationCampaignCampaign Standard Documentation

GET / POST / PATCH / DELETE verbs verbs

Last update: Mon Sep 13 2021 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Applies to:
  • Campaign Standard

CREATED FOR:

  • Experienced
  • Developer

Available verbs to perform operations on the resources are:

  • GET: retrieves one element or a collection of elements
  • POST: creates a resource with parameters.
  • PATCH: updates a resource with parameters.
  • DELETE: deletes a resource.

Sample requests

  • Sample GET request on the profile collection.

    code language-none 
    
$curl
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    It returns an array of profiles.

    code language-none 
    
{
    "content": [
        {
            "PKey": "<PKEY>",
            "firstName": "Olivia",
            "lastName": "Varney",
            "birthDate": "1977-09-°4",
            "email": "o.varney@mail.com",
        },
        {
            "PKey": "<PKEY>",
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1985-08-17",
            "email": "johndoe@mail.com",
        }
    ],
}

  • Sample GET request on a specific profile.

    code language-none 
    
$curl
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/<PKEY> \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    It returns the requested profile.

    code language-none 
    
{
    "PKey": "<PKEY>",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1985-08-17",
    "email": "johndoe@mail.com",
    ...
}

  • Sample POST request to create a profile.

    code language-none 
    
-X POST https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-d '{"lastName":"Doe"}'

    It returns the profile with the default fields.

    code language-none 
    
{
    "PKey": "<PKEY>",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1985-08-17",
    "email": "johndoe@mail.com",
}

  • Sample PATCH request to update a profile.

    code language-none 
    
-X PATCH https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/<PKEY> \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>' \
-d '{"firstName":"Mark"',"lastName":"Smith"}'

    It returns the PKEY and URL to retrieve the updated profile.

    code language-none 
    
{
    "PKey": "<PKEY>",
    "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/<PKEY>"
}

  • Sample DELETE request to delete a profile.

    code language-none 
    
-X DELETE https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/<PKEY> \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    The request returns a 200 response, confirming that the profile has been deleted.

recommendation-more-help
3ef63344-7f3d-48f9-85ed-02bf569c4fff