{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:line-manage-audience/create-audience-group":{"post":{"operationId":"communication_line_manage_audience_create_audience_group","summary":"Create audience for uploading user IDs (by JSON)","description":"POST /v2/bot/audienceGroup/upload","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/add-audience-to-audience-group":{"post":{"operationId":"communication_line_manage_audience_add_audience_to_audience_group","summary":"Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)","description":"PUT /v2/bot/audienceGroup/upload","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/create-audience-for-uploading-user-ids":{"post":{"operationId":"communication_line_manage_audience_create_audience_for_uploading_user_ids","summary":"Create audience for uploading user IDs (by file).","description":"POST /v2/bot/audienceGroup/upload/byFile","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/add-user-ids-to-audience":{"post":{"operationId":"communication_line_manage_audience_add_user_ids_to_audience","summary":"Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).","description":"PUT /v2/bot/audienceGroup/upload/byFile","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/create-click-based-audience-group":{"post":{"operationId":"communication_line_manage_audience_create_click_based_audience_group","summary":"Create audience for click-based retargeting","description":"POST /v2/bot/audienceGroup/click","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/create-imp-based-audience-group":{"post":{"operationId":"communication_line_manage_audience_create_imp_based_audience_group","summary":"Create audience for impression-based retargeting","description":"POST /v2/bot/audienceGroup/imp","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/update-audience-group-description":{"post":{"operationId":"communication_line_manage_audience_update_audience_group_description","summary":"Renames an existing audience.","description":"PUT /v2/bot/audienceGroup/{audienceGroupId}/updateDescription","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["audienceGroupId","body"],"properties":{"audienceGroupId":{"type":"integer","description":"The audience ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/get-audience-data":{"get":{"operationId":"communication_line_manage_audience_get_audience_data","summary":"Gets audience data.","description":"GET /v2/bot/audienceGroup/{audienceGroupId}","tags":["communication"],"parameters":[{"name":"audienceGroupId","in":"query","required":true,"description":"The audience ID.","schema":{"type":"integer","description":"The audience ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/delete-audience-group":{"post":{"operationId":"communication_line_manage_audience_delete_audience_group","summary":"Delete audience","description":"DELETE /v2/bot/audienceGroup/{audienceGroupId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["audienceGroupId"],"properties":{"audienceGroupId":{"type":"integer","description":"The audience ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/get-audience-groups":{"get":{"operationId":"communication_line_manage_audience_get_audience_groups","summary":"Gets data for more than one audience.","description":"GET /v2/bot/audienceGroup/list","tags":["communication"],"parameters":[{"name":"page","in":"query","required":true,"description":"The page to return when getting (paginated) results. Must be 1 or higher.","schema":{"type":"integer","description":"The page to return when getting (paginated) results. Must be 1 or higher."}},{"name":"description","in":"query","required":false,"description":"The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are…","schema":{"type":"string","description":"The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are…"}},{"name":"status","in":"query","required":false,"description":"The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.","schema":{"type":"string","enum":["IN_PROGRESS","READY","FAILED","EXPIRED","INACTIVE","ACTIVATING"],"description":"The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion."}},{"name":"size","in":"query","required":false,"description":"The number of audiences per page. Default: 20 Max: 40","schema":{"type":"integer","description":"The number of audiences per page. Default: 20 Max: 40"}},{"name":"includesExternalPublicGroups","in":"query","required":false,"description":"true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.","schema":{"type":"boolean","description":"true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel."}},{"name":"createRoute","in":"query","required":false,"description":"How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official…","schema":{"type":"string","enum":["OA_MANAGER","MESSAGING_API","POINT_AD","AD_MANAGER"],"description":"How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/get-shared-audience-data":{"get":{"operationId":"communication_line_manage_audience_get_shared_audience_data","summary":"Gets audience data.","description":"GET /v2/bot/audienceGroup/shared/{audienceGroupId}","tags":["communication"],"parameters":[{"name":"audienceGroupId","in":"query","required":true,"description":"The audience ID.","schema":{"type":"integer","description":"The audience ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:line-manage-audience/get-shared-audience-groups":{"get":{"operationId":"communication_line_manage_audience_get_shared_audience_groups","summary":"Gets data for more than one audience, including those shared by the Business Manager.","description":"GET /v2/bot/audienceGroup/shared/list","tags":["communication"],"parameters":[{"name":"page","in":"query","required":true,"description":"The page to return when getting (paginated) results. Must be 1 or higher.","schema":{"type":"integer","description":"The page to return when getting (paginated) results. Must be 1 or higher."}},{"name":"description","in":"query","required":false,"description":"The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are…","schema":{"type":"string","description":"The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are…"}},{"name":"status","in":"query","required":false,"description":"The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.","schema":{"type":"string","enum":["IN_PROGRESS","READY","FAILED","EXPIRED","INACTIVE","ACTIVATING"],"description":"The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion."}},{"name":"size","in":"query","required":false,"description":"The number of audiences per page. Default: 20 Max: 40","schema":{"type":"integer","description":"The number of audiences per page. Default: 20 Max: 40"}},{"name":"createRoute","in":"query","required":false,"description":"How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official…","schema":{"type":"string","enum":["OA_MANAGER","MESSAGING_API","POINT_AD","AD_MANAGER"],"description":"How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official…"}},{"name":"includesOwnedAudienceGroups","in":"query","required":false,"description":"true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager","schema":{"type":"boolean","default":false,"description":"true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}